nextcloud /
server
@@ -30,7 +30,7 @@ |
||
| 30 | 30 | |
| 31 | 31 | /** |
| 32 | 32 | * @param \Sabre\DAVACL\PrincipalBackend\BackendInterface $principalBackend |
| 33 | - * @param \Sabre\CardDAV\Backend\BackendInterface $carddavBackend |
|
| 33 | + * @param CardDavBackend $carddavBackend |
|
| 34 | 34 | * @param string $principalPrefix |
| 35 | 35 | */ |
| 36 | 36 | public function __construct(\Sabre\DAVACL\PrincipalBackend\BackendInterface $principalBackend, \Sabre\CardDAV\Backend\BackendInterface $carddavBackend, $principalPrefix = 'principals') { |
@@ -25,46 +25,46 @@ |
||
| 25 | 25 | |
| 26 | 26 | class AddressBookRoot extends \Sabre\CardDAV\AddressBookRoot { |
| 27 | 27 | |
| 28 | - /** @var IL10N */ |
|
| 29 | - protected $l10n; |
|
| 28 | + /** @var IL10N */ |
|
| 29 | + protected $l10n; |
|
| 30 | 30 | |
| 31 | - /** |
|
| 32 | - * @param \Sabre\DAVACL\PrincipalBackend\BackendInterface $principalBackend |
|
| 33 | - * @param \Sabre\CardDAV\Backend\BackendInterface $carddavBackend |
|
| 34 | - * @param string $principalPrefix |
|
| 35 | - */ |
|
| 36 | - public function __construct(\Sabre\DAVACL\PrincipalBackend\BackendInterface $principalBackend, \Sabre\CardDAV\Backend\BackendInterface $carddavBackend, $principalPrefix = 'principals') { |
|
| 37 | - parent::__construct($principalBackend, $carddavBackend, $principalPrefix); |
|
| 38 | - $this->l10n = \OC::$server->getL10N('dav'); |
|
| 39 | - } |
|
| 31 | + /** |
|
| 32 | + * @param \Sabre\DAVACL\PrincipalBackend\BackendInterface $principalBackend |
|
| 33 | + * @param \Sabre\CardDAV\Backend\BackendInterface $carddavBackend |
|
| 34 | + * @param string $principalPrefix |
|
| 35 | + */ |
|
| 36 | + public function __construct(\Sabre\DAVACL\PrincipalBackend\BackendInterface $principalBackend, \Sabre\CardDAV\Backend\BackendInterface $carddavBackend, $principalPrefix = 'principals') { |
|
| 37 | + parent::__construct($principalBackend, $carddavBackend, $principalPrefix); |
|
| 38 | + $this->l10n = \OC::$server->getL10N('dav'); |
|
| 39 | + } |
|
| 40 | 40 | |
| 41 | - /** |
|
| 42 | - * This method returns a node for a principal. |
|
| 43 | - * |
|
| 44 | - * The passed array contains principal information, and is guaranteed to |
|
| 45 | - * at least contain a uri item. Other properties may or may not be |
|
| 46 | - * supplied by the authentication backend. |
|
| 47 | - * |
|
| 48 | - * @param array $principal |
|
| 49 | - * @return \Sabre\DAV\INode |
|
| 50 | - */ |
|
| 51 | - function getChildForPrincipal(array $principal) { |
|
| 41 | + /** |
|
| 42 | + * This method returns a node for a principal. |
|
| 43 | + * |
|
| 44 | + * The passed array contains principal information, and is guaranteed to |
|
| 45 | + * at least contain a uri item. Other properties may or may not be |
|
| 46 | + * supplied by the authentication backend. |
|
| 47 | + * |
|
| 48 | + * @param array $principal |
|
| 49 | + * @return \Sabre\DAV\INode |
|
| 50 | + */ |
|
| 51 | + function getChildForPrincipal(array $principal) { |
|
| 52 | 52 | |
| 53 | - return new UserAddressBooks($this->carddavBackend, $principal['uri'], $this->l10n); |
|
| 53 | + return new UserAddressBooks($this->carddavBackend, $principal['uri'], $this->l10n); |
|
| 54 | 54 | |
| 55 | - } |
|
| 55 | + } |
|
| 56 | 56 | |
| 57 | - function getName() { |
|
| 57 | + function getName() { |
|
| 58 | 58 | |
| 59 | - if ($this->principalPrefix === 'principals') { |
|
| 60 | - return parent::getName(); |
|
| 61 | - } |
|
| 62 | - // Grabbing all the components of the principal path. |
|
| 63 | - $parts = explode('/', $this->principalPrefix); |
|
| 59 | + if ($this->principalPrefix === 'principals') { |
|
| 60 | + return parent::getName(); |
|
| 61 | + } |
|
| 62 | + // Grabbing all the components of the principal path. |
|
| 63 | + $parts = explode('/', $this->principalPrefix); |
|
| 64 | 64 | |
| 65 | - // We are only interested in the second part. |
|
| 66 | - return $parts[1]; |
|
| 65 | + // We are only interested in the second part. |
|
| 66 | + return $parts[1]; |
|
| 67 | 67 | |
| 68 | - } |
|
| 68 | + } |
|
| 69 | 69 | |
| 70 | 70 | } |
@@ -770,7 +770,7 @@ |
||
| 770 | 770 | |
| 771 | 771 | /** |
| 772 | 772 | * @param Share[] $shares |
| 773 | - * @param $userId |
|
| 773 | + * @param string $userId |
|
| 774 | 774 | * @return Share[] The updates shares if no update is found for a share return the original |
| 775 | 775 | */ |
| 776 | 776 | private function resolveGroupShares($shares, $userId) { |
@@ -46,1140 +46,1140 @@ |
||
| 46 | 46 | */ |
| 47 | 47 | class DefaultShareProvider implements IShareProvider { |
| 48 | 48 | |
| 49 | - // Special share type for user modified group shares |
|
| 50 | - const SHARE_TYPE_USERGROUP = 2; |
|
| 51 | - |
|
| 52 | - /** @var IDBConnection */ |
|
| 53 | - private $dbConn; |
|
| 54 | - |
|
| 55 | - /** @var IUserManager */ |
|
| 56 | - private $userManager; |
|
| 57 | - |
|
| 58 | - /** @var IGroupManager */ |
|
| 59 | - private $groupManager; |
|
| 60 | - |
|
| 61 | - /** @var IRootFolder */ |
|
| 62 | - private $rootFolder; |
|
| 63 | - |
|
| 64 | - /** |
|
| 65 | - * DefaultShareProvider constructor. |
|
| 66 | - * |
|
| 67 | - * @param IDBConnection $connection |
|
| 68 | - * @param IUserManager $userManager |
|
| 69 | - * @param IGroupManager $groupManager |
|
| 70 | - * @param IRootFolder $rootFolder |
|
| 71 | - */ |
|
| 72 | - public function __construct( |
|
| 73 | - IDBConnection $connection, |
|
| 74 | - IUserManager $userManager, |
|
| 75 | - IGroupManager $groupManager, |
|
| 76 | - IRootFolder $rootFolder) { |
|
| 77 | - $this->dbConn = $connection; |
|
| 78 | - $this->userManager = $userManager; |
|
| 79 | - $this->groupManager = $groupManager; |
|
| 80 | - $this->rootFolder = $rootFolder; |
|
| 81 | - } |
|
| 82 | - |
|
| 83 | - /** |
|
| 84 | - * Return the identifier of this provider. |
|
| 85 | - * |
|
| 86 | - * @return string Containing only [a-zA-Z0-9] |
|
| 87 | - */ |
|
| 88 | - public function identifier() { |
|
| 89 | - return 'ocinternal'; |
|
| 90 | - } |
|
| 91 | - |
|
| 92 | - /** |
|
| 93 | - * Share a path |
|
| 94 | - * |
|
| 95 | - * @param \OCP\Share\IShare $share |
|
| 96 | - * @return \OCP\Share\IShare The share object |
|
| 97 | - * @throws ShareNotFound |
|
| 98 | - * @throws \Exception |
|
| 99 | - */ |
|
| 100 | - public function create(\OCP\Share\IShare $share) { |
|
| 101 | - $qb = $this->dbConn->getQueryBuilder(); |
|
| 102 | - |
|
| 103 | - $qb->insert('share'); |
|
| 104 | - $qb->setValue('share_type', $qb->createNamedParameter($share->getShareType())); |
|
| 105 | - |
|
| 106 | - if ($share->getShareType() === \OCP\Share::SHARE_TYPE_USER) { |
|
| 107 | - //Set the UID of the user we share with |
|
| 108 | - $qb->setValue('share_with', $qb->createNamedParameter($share->getSharedWith())); |
|
| 109 | - } else if ($share->getShareType() === \OCP\Share::SHARE_TYPE_GROUP) { |
|
| 110 | - //Set the GID of the group we share with |
|
| 111 | - $qb->setValue('share_with', $qb->createNamedParameter($share->getSharedWith())); |
|
| 112 | - } else if ($share->getShareType() === \OCP\Share::SHARE_TYPE_LINK) { |
|
| 113 | - //Set the token of the share |
|
| 114 | - $qb->setValue('token', $qb->createNamedParameter($share->getToken())); |
|
| 115 | - |
|
| 116 | - //If a password is set store it |
|
| 117 | - if ($share->getPassword() !== null) { |
|
| 118 | - $qb->setValue('password', $qb->createNamedParameter($share->getPassword())); |
|
| 119 | - } |
|
| 120 | - |
|
| 121 | - //If an expiration date is set store it |
|
| 122 | - if ($share->getExpirationDate() !== null) { |
|
| 123 | - $qb->setValue('expiration', $qb->createNamedParameter($share->getExpirationDate(), 'datetime')); |
|
| 124 | - } |
|
| 125 | - |
|
| 126 | - if (method_exists($share, 'getParent')) { |
|
| 127 | - $qb->setValue('parent', $qb->createNamedParameter($share->getParent())); |
|
| 128 | - } |
|
| 129 | - } else { |
|
| 130 | - throw new \Exception('invalid share type!'); |
|
| 131 | - } |
|
| 132 | - |
|
| 133 | - // Set what is shares |
|
| 134 | - $qb->setValue('item_type', $qb->createParameter('itemType')); |
|
| 135 | - if ($share->getNode() instanceof \OCP\Files\File) { |
|
| 136 | - $qb->setParameter('itemType', 'file'); |
|
| 137 | - } else { |
|
| 138 | - $qb->setParameter('itemType', 'folder'); |
|
| 139 | - } |
|
| 140 | - |
|
| 141 | - // Set the file id |
|
| 142 | - $qb->setValue('item_source', $qb->createNamedParameter($share->getNode()->getId())); |
|
| 143 | - $qb->setValue('file_source', $qb->createNamedParameter($share->getNode()->getId())); |
|
| 144 | - |
|
| 145 | - // set the permissions |
|
| 146 | - $qb->setValue('permissions', $qb->createNamedParameter($share->getPermissions())); |
|
| 147 | - |
|
| 148 | - // Set who created this share |
|
| 149 | - $qb->setValue('uid_initiator', $qb->createNamedParameter($share->getSharedBy())); |
|
| 150 | - |
|
| 151 | - // Set who is the owner of this file/folder (and this the owner of the share) |
|
| 152 | - $qb->setValue('uid_owner', $qb->createNamedParameter($share->getShareOwner())); |
|
| 153 | - |
|
| 154 | - // Set the file target |
|
| 155 | - $qb->setValue('file_target', $qb->createNamedParameter($share->getTarget())); |
|
| 156 | - |
|
| 157 | - // Set the time this share was created |
|
| 158 | - $qb->setValue('stime', $qb->createNamedParameter(time())); |
|
| 159 | - |
|
| 160 | - // insert the data and fetch the id of the share |
|
| 161 | - $this->dbConn->beginTransaction(); |
|
| 162 | - $qb->execute(); |
|
| 163 | - $id = $this->dbConn->lastInsertId('*PREFIX*share'); |
|
| 164 | - |
|
| 165 | - // Now fetch the inserted share and create a complete share object |
|
| 166 | - $qb = $this->dbConn->getQueryBuilder(); |
|
| 167 | - $qb->select('*') |
|
| 168 | - ->from('share') |
|
| 169 | - ->where($qb->expr()->eq('id', $qb->createNamedParameter($id))); |
|
| 170 | - |
|
| 171 | - $cursor = $qb->execute(); |
|
| 172 | - $data = $cursor->fetch(); |
|
| 173 | - $this->dbConn->commit(); |
|
| 174 | - $cursor->closeCursor(); |
|
| 175 | - |
|
| 176 | - if ($data === false) { |
|
| 177 | - throw new ShareNotFound(); |
|
| 178 | - } |
|
| 179 | - |
|
| 180 | - $share = $this->createShare($data); |
|
| 181 | - return $share; |
|
| 182 | - } |
|
| 183 | - |
|
| 184 | - /** |
|
| 185 | - * Update a share |
|
| 186 | - * |
|
| 187 | - * @param \OCP\Share\IShare $share |
|
| 188 | - * @return \OCP\Share\IShare The share object |
|
| 189 | - */ |
|
| 190 | - public function update(\OCP\Share\IShare $share) { |
|
| 191 | - if ($share->getShareType() === \OCP\Share::SHARE_TYPE_USER) { |
|
| 192 | - /* |
|
| 49 | + // Special share type for user modified group shares |
|
| 50 | + const SHARE_TYPE_USERGROUP = 2; |
|
| 51 | + |
|
| 52 | + /** @var IDBConnection */ |
|
| 53 | + private $dbConn; |
|
| 54 | + |
|
| 55 | + /** @var IUserManager */ |
|
| 56 | + private $userManager; |
|
| 57 | + |
|
| 58 | + /** @var IGroupManager */ |
|
| 59 | + private $groupManager; |
|
| 60 | + |
|
| 61 | + /** @var IRootFolder */ |
|
| 62 | + private $rootFolder; |
|
| 63 | + |
|
| 64 | + /** |
|
| 65 | + * DefaultShareProvider constructor. |
|
| 66 | + * |
|
| 67 | + * @param IDBConnection $connection |
|
| 68 | + * @param IUserManager $userManager |
|
| 69 | + * @param IGroupManager $groupManager |
|
| 70 | + * @param IRootFolder $rootFolder |
|
| 71 | + */ |
|
| 72 | + public function __construct( |
|
| 73 | + IDBConnection $connection, |
|
| 74 | + IUserManager $userManager, |
|
| 75 | + IGroupManager $groupManager, |
|
| 76 | + IRootFolder $rootFolder) { |
|
| 77 | + $this->dbConn = $connection; |
|
| 78 | + $this->userManager = $userManager; |
|
| 79 | + $this->groupManager = $groupManager; |
|
| 80 | + $this->rootFolder = $rootFolder; |
|
| 81 | + } |
|
| 82 | + |
|
| 83 | + /** |
|
| 84 | + * Return the identifier of this provider. |
|
| 85 | + * |
|
| 86 | + * @return string Containing only [a-zA-Z0-9] |
|
| 87 | + */ |
|
| 88 | + public function identifier() { |
|
| 89 | + return 'ocinternal'; |
|
| 90 | + } |
|
| 91 | + |
|
| 92 | + /** |
|
| 93 | + * Share a path |
|
| 94 | + * |
|
| 95 | + * @param \OCP\Share\IShare $share |
|
| 96 | + * @return \OCP\Share\IShare The share object |
|
| 97 | + * @throws ShareNotFound |
|
| 98 | + * @throws \Exception |
|
| 99 | + */ |
|
| 100 | + public function create(\OCP\Share\IShare $share) { |
|
| 101 | + $qb = $this->dbConn->getQueryBuilder(); |
|
| 102 | + |
|
| 103 | + $qb->insert('share'); |
|
| 104 | + $qb->setValue('share_type', $qb->createNamedParameter($share->getShareType())); |
|
| 105 | + |
|
| 106 | + if ($share->getShareType() === \OCP\Share::SHARE_TYPE_USER) { |
|
| 107 | + //Set the UID of the user we share with |
|
| 108 | + $qb->setValue('share_with', $qb->createNamedParameter($share->getSharedWith())); |
|
| 109 | + } else if ($share->getShareType() === \OCP\Share::SHARE_TYPE_GROUP) { |
|
| 110 | + //Set the GID of the group we share with |
|
| 111 | + $qb->setValue('share_with', $qb->createNamedParameter($share->getSharedWith())); |
|
| 112 | + } else if ($share->getShareType() === \OCP\Share::SHARE_TYPE_LINK) { |
|
| 113 | + //Set the token of the share |
|
| 114 | + $qb->setValue('token', $qb->createNamedParameter($share->getToken())); |
|
| 115 | + |
|
| 116 | + //If a password is set store it |
|
| 117 | + if ($share->getPassword() !== null) { |
|
| 118 | + $qb->setValue('password', $qb->createNamedParameter($share->getPassword())); |
|
| 119 | + } |
|
| 120 | + |
|
| 121 | + //If an expiration date is set store it |
|
| 122 | + if ($share->getExpirationDate() !== null) { |
|
| 123 | + $qb->setValue('expiration', $qb->createNamedParameter($share->getExpirationDate(), 'datetime')); |
|
| 124 | + } |
|
| 125 | + |
|
| 126 | + if (method_exists($share, 'getParent')) { |
|
| 127 | + $qb->setValue('parent', $qb->createNamedParameter($share->getParent())); |
|
| 128 | + } |
|
| 129 | + } else { |
|
| 130 | + throw new \Exception('invalid share type!'); |
|
| 131 | + } |
|
| 132 | + |
|
| 133 | + // Set what is shares |
|
| 134 | + $qb->setValue('item_type', $qb->createParameter('itemType')); |
|
| 135 | + if ($share->getNode() instanceof \OCP\Files\File) { |
|
| 136 | + $qb->setParameter('itemType', 'file'); |
|
| 137 | + } else { |
|
| 138 | + $qb->setParameter('itemType', 'folder'); |
|
| 139 | + } |
|
| 140 | + |
|
| 141 | + // Set the file id |
|
| 142 | + $qb->setValue('item_source', $qb->createNamedParameter($share->getNode()->getId())); |
|
| 143 | + $qb->setValue('file_source', $qb->createNamedParameter($share->getNode()->getId())); |
|
| 144 | + |
|
| 145 | + // set the permissions |
|
| 146 | + $qb->setValue('permissions', $qb->createNamedParameter($share->getPermissions())); |
|
| 147 | + |
|
| 148 | + // Set who created this share |
|
| 149 | + $qb->setValue('uid_initiator', $qb->createNamedParameter($share->getSharedBy())); |
|
| 150 | + |
|
| 151 | + // Set who is the owner of this file/folder (and this the owner of the share) |
|
| 152 | + $qb->setValue('uid_owner', $qb->createNamedParameter($share->getShareOwner())); |
|
| 153 | + |
|
| 154 | + // Set the file target |
|
| 155 | + $qb->setValue('file_target', $qb->createNamedParameter($share->getTarget())); |
|
| 156 | + |
|
| 157 | + // Set the time this share was created |
|
| 158 | + $qb->setValue('stime', $qb->createNamedParameter(time())); |
|
| 159 | + |
|
| 160 | + // insert the data and fetch the id of the share |
|
| 161 | + $this->dbConn->beginTransaction(); |
|
| 162 | + $qb->execute(); |
|
| 163 | + $id = $this->dbConn->lastInsertId('*PREFIX*share'); |
|
| 164 | + |
|
| 165 | + // Now fetch the inserted share and create a complete share object |
|
| 166 | + $qb = $this->dbConn->getQueryBuilder(); |
|
| 167 | + $qb->select('*') |
|
| 168 | + ->from('share') |
|
| 169 | + ->where($qb->expr()->eq('id', $qb->createNamedParameter($id))); |
|
| 170 | + |
|
| 171 | + $cursor = $qb->execute(); |
|
| 172 | + $data = $cursor->fetch(); |
|
| 173 | + $this->dbConn->commit(); |
|
| 174 | + $cursor->closeCursor(); |
|
| 175 | + |
|
| 176 | + if ($data === false) { |
|
| 177 | + throw new ShareNotFound(); |
|
| 178 | + } |
|
| 179 | + |
|
| 180 | + $share = $this->createShare($data); |
|
| 181 | + return $share; |
|
| 182 | + } |
|
| 183 | + |
|
| 184 | + /** |
|
| 185 | + * Update a share |
|
| 186 | + * |
|
| 187 | + * @param \OCP\Share\IShare $share |
|
| 188 | + * @return \OCP\Share\IShare The share object |
|
| 189 | + */ |
|
| 190 | + public function update(\OCP\Share\IShare $share) { |
|
| 191 | + if ($share->getShareType() === \OCP\Share::SHARE_TYPE_USER) { |
|
| 192 | + /* |
|
| 193 | 193 | * We allow updating the recipient on user shares. |
| 194 | 194 | */ |
| 195 | - $qb = $this->dbConn->getQueryBuilder(); |
|
| 196 | - $qb->update('share') |
|
| 197 | - ->where($qb->expr()->eq('id', $qb->createNamedParameter($share->getId()))) |
|
| 198 | - ->set('share_with', $qb->createNamedParameter($share->getSharedWith())) |
|
| 199 | - ->set('uid_owner', $qb->createNamedParameter($share->getShareOwner())) |
|
| 200 | - ->set('uid_initiator', $qb->createNamedParameter($share->getSharedBy())) |
|
| 201 | - ->set('permissions', $qb->createNamedParameter($share->getPermissions())) |
|
| 202 | - ->set('item_source', $qb->createNamedParameter($share->getNode()->getId())) |
|
| 203 | - ->set('file_source', $qb->createNamedParameter($share->getNode()->getId())) |
|
| 204 | - ->set('expiration', $qb->createNamedParameter($share->getExpirationDate(), IQueryBuilder::PARAM_DATE)) |
|
| 205 | - ->execute(); |
|
| 206 | - } else if ($share->getShareType() === \OCP\Share::SHARE_TYPE_GROUP) { |
|
| 207 | - $qb = $this->dbConn->getQueryBuilder(); |
|
| 208 | - $qb->update('share') |
|
| 209 | - ->where($qb->expr()->eq('id', $qb->createNamedParameter($share->getId()))) |
|
| 210 | - ->set('uid_owner', $qb->createNamedParameter($share->getShareOwner())) |
|
| 211 | - ->set('uid_initiator', $qb->createNamedParameter($share->getSharedBy())) |
|
| 212 | - ->set('permissions', $qb->createNamedParameter($share->getPermissions())) |
|
| 213 | - ->set('item_source', $qb->createNamedParameter($share->getNode()->getId())) |
|
| 214 | - ->set('file_source', $qb->createNamedParameter($share->getNode()->getId())) |
|
| 215 | - ->set('expiration', $qb->createNamedParameter($share->getExpirationDate(), IQueryBuilder::PARAM_DATE)) |
|
| 216 | - ->execute(); |
|
| 217 | - |
|
| 218 | - /* |
|
| 195 | + $qb = $this->dbConn->getQueryBuilder(); |
|
| 196 | + $qb->update('share') |
|
| 197 | + ->where($qb->expr()->eq('id', $qb->createNamedParameter($share->getId()))) |
|
| 198 | + ->set('share_with', $qb->createNamedParameter($share->getSharedWith())) |
|
| 199 | + ->set('uid_owner', $qb->createNamedParameter($share->getShareOwner())) |
|
| 200 | + ->set('uid_initiator', $qb->createNamedParameter($share->getSharedBy())) |
|
| 201 | + ->set('permissions', $qb->createNamedParameter($share->getPermissions())) |
|
| 202 | + ->set('item_source', $qb->createNamedParameter($share->getNode()->getId())) |
|
| 203 | + ->set('file_source', $qb->createNamedParameter($share->getNode()->getId())) |
|
| 204 | + ->set('expiration', $qb->createNamedParameter($share->getExpirationDate(), IQueryBuilder::PARAM_DATE)) |
|
| 205 | + ->execute(); |
|
| 206 | + } else if ($share->getShareType() === \OCP\Share::SHARE_TYPE_GROUP) { |
|
| 207 | + $qb = $this->dbConn->getQueryBuilder(); |
|
| 208 | + $qb->update('share') |
|
| 209 | + ->where($qb->expr()->eq('id', $qb->createNamedParameter($share->getId()))) |
|
| 210 | + ->set('uid_owner', $qb->createNamedParameter($share->getShareOwner())) |
|
| 211 | + ->set('uid_initiator', $qb->createNamedParameter($share->getSharedBy())) |
|
| 212 | + ->set('permissions', $qb->createNamedParameter($share->getPermissions())) |
|
| 213 | + ->set('item_source', $qb->createNamedParameter($share->getNode()->getId())) |
|
| 214 | + ->set('file_source', $qb->createNamedParameter($share->getNode()->getId())) |
|
| 215 | + ->set('expiration', $qb->createNamedParameter($share->getExpirationDate(), IQueryBuilder::PARAM_DATE)) |
|
| 216 | + ->execute(); |
|
| 217 | + |
|
| 218 | + /* |
|
| 219 | 219 | * Update all user defined group shares |
| 220 | 220 | */ |
| 221 | - $qb = $this->dbConn->getQueryBuilder(); |
|
| 222 | - $qb->update('share') |
|
| 223 | - ->where($qb->expr()->eq('parent', $qb->createNamedParameter($share->getId()))) |
|
| 224 | - ->set('uid_owner', $qb->createNamedParameter($share->getShareOwner())) |
|
| 225 | - ->set('uid_initiator', $qb->createNamedParameter($share->getSharedBy())) |
|
| 226 | - ->set('item_source', $qb->createNamedParameter($share->getNode()->getId())) |
|
| 227 | - ->set('file_source', $qb->createNamedParameter($share->getNode()->getId())) |
|
| 228 | - ->set('expiration', $qb->createNamedParameter($share->getExpirationDate(), IQueryBuilder::PARAM_DATE)) |
|
| 229 | - ->execute(); |
|
| 230 | - |
|
| 231 | - /* |
|
| 221 | + $qb = $this->dbConn->getQueryBuilder(); |
|
| 222 | + $qb->update('share') |
|
| 223 | + ->where($qb->expr()->eq('parent', $qb->createNamedParameter($share->getId()))) |
|
| 224 | + ->set('uid_owner', $qb->createNamedParameter($share->getShareOwner())) |
|
| 225 | + ->set('uid_initiator', $qb->createNamedParameter($share->getSharedBy())) |
|
| 226 | + ->set('item_source', $qb->createNamedParameter($share->getNode()->getId())) |
|
| 227 | + ->set('file_source', $qb->createNamedParameter($share->getNode()->getId())) |
|
| 228 | + ->set('expiration', $qb->createNamedParameter($share->getExpirationDate(), IQueryBuilder::PARAM_DATE)) |
|
| 229 | + ->execute(); |
|
| 230 | + |
|
| 231 | + /* |
|
| 232 | 232 | * Now update the permissions for all children that have not set it to 0 |
| 233 | 233 | */ |
| 234 | - $qb = $this->dbConn->getQueryBuilder(); |
|
| 235 | - $qb->update('share') |
|
| 236 | - ->where($qb->expr()->eq('parent', $qb->createNamedParameter($share->getId()))) |
|
| 237 | - ->andWhere($qb->expr()->neq('permissions', $qb->createNamedParameter(0))) |
|
| 238 | - ->set('permissions', $qb->createNamedParameter($share->getPermissions())) |
|
| 239 | - ->execute(); |
|
| 240 | - |
|
| 241 | - } else if ($share->getShareType() === \OCP\Share::SHARE_TYPE_LINK) { |
|
| 242 | - $qb = $this->dbConn->getQueryBuilder(); |
|
| 243 | - $qb->update('share') |
|
| 244 | - ->where($qb->expr()->eq('id', $qb->createNamedParameter($share->getId()))) |
|
| 245 | - ->set('password', $qb->createNamedParameter($share->getPassword())) |
|
| 246 | - ->set('uid_owner', $qb->createNamedParameter($share->getShareOwner())) |
|
| 247 | - ->set('uid_initiator', $qb->createNamedParameter($share->getSharedBy())) |
|
| 248 | - ->set('permissions', $qb->createNamedParameter($share->getPermissions())) |
|
| 249 | - ->set('item_source', $qb->createNamedParameter($share->getNode()->getId())) |
|
| 250 | - ->set('file_source', $qb->createNamedParameter($share->getNode()->getId())) |
|
| 251 | - ->set('token', $qb->createNamedParameter($share->getToken())) |
|
| 252 | - ->set('expiration', $qb->createNamedParameter($share->getExpirationDate(), IQueryBuilder::PARAM_DATE)) |
|
| 253 | - ->execute(); |
|
| 254 | - } |
|
| 255 | - |
|
| 256 | - return $share; |
|
| 257 | - } |
|
| 258 | - |
|
| 259 | - /** |
|
| 260 | - * Get all children of this share |
|
| 261 | - * FIXME: remove once https://github.com/owncloud/core/pull/21660 is in |
|
| 262 | - * |
|
| 263 | - * @param \OCP\Share\IShare $parent |
|
| 264 | - * @return \OCP\Share\IShare[] |
|
| 265 | - */ |
|
| 266 | - public function getChildren(\OCP\Share\IShare $parent) { |
|
| 267 | - $children = []; |
|
| 268 | - |
|
| 269 | - $qb = $this->dbConn->getQueryBuilder(); |
|
| 270 | - $qb->select('*') |
|
| 271 | - ->from('share') |
|
| 272 | - ->where($qb->expr()->eq('parent', $qb->createNamedParameter($parent->getId()))) |
|
| 273 | - ->andWhere( |
|
| 274 | - $qb->expr()->in( |
|
| 275 | - 'share_type', |
|
| 276 | - $qb->createNamedParameter([ |
|
| 277 | - \OCP\Share::SHARE_TYPE_USER, |
|
| 278 | - \OCP\Share::SHARE_TYPE_GROUP, |
|
| 279 | - \OCP\Share::SHARE_TYPE_LINK, |
|
| 280 | - ], IQueryBuilder::PARAM_INT_ARRAY) |
|
| 281 | - ) |
|
| 282 | - ) |
|
| 283 | - ->andWhere($qb->expr()->orX( |
|
| 284 | - $qb->expr()->eq('item_type', $qb->createNamedParameter('file')), |
|
| 285 | - $qb->expr()->eq('item_type', $qb->createNamedParameter('folder')) |
|
| 286 | - )) |
|
| 287 | - ->orderBy('id'); |
|
| 288 | - |
|
| 289 | - $cursor = $qb->execute(); |
|
| 290 | - while($data = $cursor->fetch()) { |
|
| 291 | - $children[] = $this->createShare($data); |
|
| 292 | - } |
|
| 293 | - $cursor->closeCursor(); |
|
| 294 | - |
|
| 295 | - return $children; |
|
| 296 | - } |
|
| 297 | - |
|
| 298 | - /** |
|
| 299 | - * Delete a share |
|
| 300 | - * |
|
| 301 | - * @param \OCP\Share\IShare $share |
|
| 302 | - */ |
|
| 303 | - public function delete(\OCP\Share\IShare $share) { |
|
| 304 | - $qb = $this->dbConn->getQueryBuilder(); |
|
| 305 | - $qb->delete('share') |
|
| 306 | - ->where($qb->expr()->eq('id', $qb->createNamedParameter($share->getId()))); |
|
| 307 | - |
|
| 308 | - /* |
|
| 234 | + $qb = $this->dbConn->getQueryBuilder(); |
|
| 235 | + $qb->update('share') |
|
| 236 | + ->where($qb->expr()->eq('parent', $qb->createNamedParameter($share->getId()))) |
|
| 237 | + ->andWhere($qb->expr()->neq('permissions', $qb->createNamedParameter(0))) |
|
| 238 | + ->set('permissions', $qb->createNamedParameter($share->getPermissions())) |
|
| 239 | + ->execute(); |
|
| 240 | + |
|
| 241 | + } else if ($share->getShareType() === \OCP\Share::SHARE_TYPE_LINK) { |
|
| 242 | + $qb = $this->dbConn->getQueryBuilder(); |
|
| 243 | + $qb->update('share') |
|
| 244 | + ->where($qb->expr()->eq('id', $qb->createNamedParameter($share->getId()))) |
|
| 245 | + ->set('password', $qb->createNamedParameter($share->getPassword())) |
|
| 246 | + ->set('uid_owner', $qb->createNamedParameter($share->getShareOwner())) |
|
| 247 | + ->set('uid_initiator', $qb->createNamedParameter($share->getSharedBy())) |
|
| 248 | + ->set('permissions', $qb->createNamedParameter($share->getPermissions())) |
|
| 249 | + ->set('item_source', $qb->createNamedParameter($share->getNode()->getId())) |
|
| 250 | + ->set('file_source', $qb->createNamedParameter($share->getNode()->getId())) |
|
| 251 | + ->set('token', $qb->createNamedParameter($share->getToken())) |
|
| 252 | + ->set('expiration', $qb->createNamedParameter($share->getExpirationDate(), IQueryBuilder::PARAM_DATE)) |
|
| 253 | + ->execute(); |
|
| 254 | + } |
|
| 255 | + |
|
| 256 | + return $share; |
|
| 257 | + } |
|
| 258 | + |
|
| 259 | + /** |
|
| 260 | + * Get all children of this share |
|
| 261 | + * FIXME: remove once https://github.com/owncloud/core/pull/21660 is in |
|
| 262 | + * |
|
| 263 | + * @param \OCP\Share\IShare $parent |
|
| 264 | + * @return \OCP\Share\IShare[] |
|
| 265 | + */ |
|
| 266 | + public function getChildren(\OCP\Share\IShare $parent) { |
|
| 267 | + $children = []; |
|
| 268 | + |
|
| 269 | + $qb = $this->dbConn->getQueryBuilder(); |
|
| 270 | + $qb->select('*') |
|
| 271 | + ->from('share') |
|
| 272 | + ->where($qb->expr()->eq('parent', $qb->createNamedParameter($parent->getId()))) |
|
| 273 | + ->andWhere( |
|
| 274 | + $qb->expr()->in( |
|
| 275 | + 'share_type', |
|
| 276 | + $qb->createNamedParameter([ |
|
| 277 | + \OCP\Share::SHARE_TYPE_USER, |
|
| 278 | + \OCP\Share::SHARE_TYPE_GROUP, |
|
| 279 | + \OCP\Share::SHARE_TYPE_LINK, |
|
| 280 | + ], IQueryBuilder::PARAM_INT_ARRAY) |
|
| 281 | + ) |
|
| 282 | + ) |
|
| 283 | + ->andWhere($qb->expr()->orX( |
|
| 284 | + $qb->expr()->eq('item_type', $qb->createNamedParameter('file')), |
|
| 285 | + $qb->expr()->eq('item_type', $qb->createNamedParameter('folder')) |
|
| 286 | + )) |
|
| 287 | + ->orderBy('id'); |
|
| 288 | + |
|
| 289 | + $cursor = $qb->execute(); |
|
| 290 | + while($data = $cursor->fetch()) { |
|
| 291 | + $children[] = $this->createShare($data); |
|
| 292 | + } |
|
| 293 | + $cursor->closeCursor(); |
|
| 294 | + |
|
| 295 | + return $children; |
|
| 296 | + } |
|
| 297 | + |
|
| 298 | + /** |
|
| 299 | + * Delete a share |
|
| 300 | + * |
|
| 301 | + * @param \OCP\Share\IShare $share |
|
| 302 | + */ |
|
| 303 | + public function delete(\OCP\Share\IShare $share) { |
|
| 304 | + $qb = $this->dbConn->getQueryBuilder(); |
|
| 305 | + $qb->delete('share') |
|
| 306 | + ->where($qb->expr()->eq('id', $qb->createNamedParameter($share->getId()))); |
|
| 307 | + |
|
| 308 | + /* |
|
| 309 | 309 | * If the share is a group share delete all possible |
| 310 | 310 | * user defined groups shares. |
| 311 | 311 | */ |
| 312 | - if ($share->getShareType() === \OCP\Share::SHARE_TYPE_GROUP) { |
|
| 313 | - $qb->orWhere($qb->expr()->eq('parent', $qb->createNamedParameter($share->getId()))); |
|
| 314 | - } |
|
| 315 | - |
|
| 316 | - $qb->execute(); |
|
| 317 | - } |
|
| 318 | - |
|
| 319 | - /** |
|
| 320 | - * Unshare a share from the recipient. If this is a group share |
|
| 321 | - * this means we need a special entry in the share db. |
|
| 322 | - * |
|
| 323 | - * @param \OCP\Share\IShare $share |
|
| 324 | - * @param string $recipient UserId of recipient |
|
| 325 | - * @throws BackendError |
|
| 326 | - * @throws ProviderException |
|
| 327 | - */ |
|
| 328 | - public function deleteFromSelf(\OCP\Share\IShare $share, $recipient) { |
|
| 329 | - if ($share->getShareType() === \OCP\Share::SHARE_TYPE_GROUP) { |
|
| 330 | - |
|
| 331 | - $group = $this->groupManager->get($share->getSharedWith()); |
|
| 332 | - $user = $this->userManager->get($recipient); |
|
| 333 | - |
|
| 334 | - if (is_null($group)) { |
|
| 335 | - throw new ProviderException('Group "' . $share->getSharedWith() . '" does not exist'); |
|
| 336 | - } |
|
| 337 | - |
|
| 338 | - if (!$group->inGroup($user)) { |
|
| 339 | - throw new ProviderException('Recipient not in receiving group'); |
|
| 340 | - } |
|
| 341 | - |
|
| 342 | - // Try to fetch user specific share |
|
| 343 | - $qb = $this->dbConn->getQueryBuilder(); |
|
| 344 | - $stmt = $qb->select('*') |
|
| 345 | - ->from('share') |
|
| 346 | - ->where($qb->expr()->eq('share_type', $qb->createNamedParameter(self::SHARE_TYPE_USERGROUP))) |
|
| 347 | - ->andWhere($qb->expr()->eq('share_with', $qb->createNamedParameter($recipient))) |
|
| 348 | - ->andWhere($qb->expr()->eq('parent', $qb->createNamedParameter($share->getId()))) |
|
| 349 | - ->andWhere($qb->expr()->orX( |
|
| 350 | - $qb->expr()->eq('item_type', $qb->createNamedParameter('file')), |
|
| 351 | - $qb->expr()->eq('item_type', $qb->createNamedParameter('folder')) |
|
| 352 | - )) |
|
| 353 | - ->execute(); |
|
| 354 | - |
|
| 355 | - $data = $stmt->fetch(); |
|
| 356 | - |
|
| 357 | - /* |
|
| 312 | + if ($share->getShareType() === \OCP\Share::SHARE_TYPE_GROUP) { |
|
| 313 | + $qb->orWhere($qb->expr()->eq('parent', $qb->createNamedParameter($share->getId()))); |
|
| 314 | + } |
|
| 315 | + |
|
| 316 | + $qb->execute(); |
|
| 317 | + } |
|
| 318 | + |
|
| 319 | + /** |
|
| 320 | + * Unshare a share from the recipient. If this is a group share |
|
| 321 | + * this means we need a special entry in the share db. |
|
| 322 | + * |
|
| 323 | + * @param \OCP\Share\IShare $share |
|
| 324 | + * @param string $recipient UserId of recipient |
|
| 325 | + * @throws BackendError |
|
| 326 | + * @throws ProviderException |
|
| 327 | + */ |
|
| 328 | + public function deleteFromSelf(\OCP\Share\IShare $share, $recipient) { |
|
| 329 | + if ($share->getShareType() === \OCP\Share::SHARE_TYPE_GROUP) { |
|
| 330 | + |
|
| 331 | + $group = $this->groupManager->get($share->getSharedWith()); |
|
| 332 | + $user = $this->userManager->get($recipient); |
|
| 333 | + |
|
| 334 | + if (is_null($group)) { |
|
| 335 | + throw new ProviderException('Group "' . $share->getSharedWith() . '" does not exist'); |
|
| 336 | + } |
|
| 337 | + |
|
| 338 | + if (!$group->inGroup($user)) { |
|
| 339 | + throw new ProviderException('Recipient not in receiving group'); |
|
| 340 | + } |
|
| 341 | + |
|
| 342 | + // Try to fetch user specific share |
|
| 343 | + $qb = $this->dbConn->getQueryBuilder(); |
|
| 344 | + $stmt = $qb->select('*') |
|
| 345 | + ->from('share') |
|
| 346 | + ->where($qb->expr()->eq('share_type', $qb->createNamedParameter(self::SHARE_TYPE_USERGROUP))) |
|
| 347 | + ->andWhere($qb->expr()->eq('share_with', $qb->createNamedParameter($recipient))) |
|
| 348 | + ->andWhere($qb->expr()->eq('parent', $qb->createNamedParameter($share->getId()))) |
|
| 349 | + ->andWhere($qb->expr()->orX( |
|
| 350 | + $qb->expr()->eq('item_type', $qb->createNamedParameter('file')), |
|
| 351 | + $qb->expr()->eq('item_type', $qb->createNamedParameter('folder')) |
|
| 352 | + )) |
|
| 353 | + ->execute(); |
|
| 354 | + |
|
| 355 | + $data = $stmt->fetch(); |
|
| 356 | + |
|
| 357 | + /* |
|
| 358 | 358 | * Check if there already is a user specific group share. |
| 359 | 359 | * If there is update it (if required). |
| 360 | 360 | */ |
| 361 | - if ($data === false) { |
|
| 362 | - $qb = $this->dbConn->getQueryBuilder(); |
|
| 363 | - |
|
| 364 | - $type = $share->getNodeType(); |
|
| 365 | - |
|
| 366 | - //Insert new share |
|
| 367 | - $qb->insert('share') |
|
| 368 | - ->values([ |
|
| 369 | - 'share_type' => $qb->createNamedParameter(self::SHARE_TYPE_USERGROUP), |
|
| 370 | - 'share_with' => $qb->createNamedParameter($recipient), |
|
| 371 | - 'uid_owner' => $qb->createNamedParameter($share->getShareOwner()), |
|
| 372 | - 'uid_initiator' => $qb->createNamedParameter($share->getSharedBy()), |
|
| 373 | - 'parent' => $qb->createNamedParameter($share->getId()), |
|
| 374 | - 'item_type' => $qb->createNamedParameter($type), |
|
| 375 | - 'item_source' => $qb->createNamedParameter($share->getNodeId()), |
|
| 376 | - 'file_source' => $qb->createNamedParameter($share->getNodeId()), |
|
| 377 | - 'file_target' => $qb->createNamedParameter($share->getTarget()), |
|
| 378 | - 'permissions' => $qb->createNamedParameter(0), |
|
| 379 | - 'stime' => $qb->createNamedParameter($share->getShareTime()->getTimestamp()), |
|
| 380 | - ])->execute(); |
|
| 381 | - |
|
| 382 | - } else if ($data['permissions'] !== 0) { |
|
| 383 | - |
|
| 384 | - // Update existing usergroup share |
|
| 385 | - $qb = $this->dbConn->getQueryBuilder(); |
|
| 386 | - $qb->update('share') |
|
| 387 | - ->set('permissions', $qb->createNamedParameter(0)) |
|
| 388 | - ->where($qb->expr()->eq('id', $qb->createNamedParameter($data['id']))) |
|
| 389 | - ->execute(); |
|
| 390 | - } |
|
| 391 | - |
|
| 392 | - } else if ($share->getShareType() === \OCP\Share::SHARE_TYPE_USER) { |
|
| 393 | - |
|
| 394 | - if ($share->getSharedWith() !== $recipient) { |
|
| 395 | - throw new ProviderException('Recipient does not match'); |
|
| 396 | - } |
|
| 397 | - |
|
| 398 | - // We can just delete user and link shares |
|
| 399 | - $this->delete($share); |
|
| 400 | - } else { |
|
| 401 | - throw new ProviderException('Invalid shareType'); |
|
| 402 | - } |
|
| 403 | - } |
|
| 404 | - |
|
| 405 | - /** |
|
| 406 | - * @inheritdoc |
|
| 407 | - */ |
|
| 408 | - public function move(\OCP\Share\IShare $share, $recipient) { |
|
| 409 | - if ($share->getShareType() === \OCP\Share::SHARE_TYPE_USER) { |
|
| 410 | - // Just update the target |
|
| 411 | - $qb = $this->dbConn->getQueryBuilder(); |
|
| 412 | - $qb->update('share') |
|
| 413 | - ->set('file_target', $qb->createNamedParameter($share->getTarget())) |
|
| 414 | - ->where($qb->expr()->eq('id', $qb->createNamedParameter($share->getId()))) |
|
| 415 | - ->execute(); |
|
| 416 | - |
|
| 417 | - } else if ($share->getShareType() === \OCP\Share::SHARE_TYPE_GROUP) { |
|
| 418 | - |
|
| 419 | - // Check if there is a usergroup share |
|
| 420 | - $qb = $this->dbConn->getQueryBuilder(); |
|
| 421 | - $stmt = $qb->select('id') |
|
| 422 | - ->from('share') |
|
| 423 | - ->where($qb->expr()->eq('share_type', $qb->createNamedParameter(self::SHARE_TYPE_USERGROUP))) |
|
| 424 | - ->andWhere($qb->expr()->eq('share_with', $qb->createNamedParameter($recipient))) |
|
| 425 | - ->andWhere($qb->expr()->eq('parent', $qb->createNamedParameter($share->getId()))) |
|
| 426 | - ->andWhere($qb->expr()->orX( |
|
| 427 | - $qb->expr()->eq('item_type', $qb->createNamedParameter('file')), |
|
| 428 | - $qb->expr()->eq('item_type', $qb->createNamedParameter('folder')) |
|
| 429 | - )) |
|
| 430 | - ->setMaxResults(1) |
|
| 431 | - ->execute(); |
|
| 432 | - |
|
| 433 | - $data = $stmt->fetch(); |
|
| 434 | - $stmt->closeCursor(); |
|
| 435 | - |
|
| 436 | - if ($data === false) { |
|
| 437 | - // No usergroup share yet. Create one. |
|
| 438 | - $qb = $this->dbConn->getQueryBuilder(); |
|
| 439 | - $qb->insert('share') |
|
| 440 | - ->values([ |
|
| 441 | - 'share_type' => $qb->createNamedParameter(self::SHARE_TYPE_USERGROUP), |
|
| 442 | - 'share_with' => $qb->createNamedParameter($recipient), |
|
| 443 | - 'uid_owner' => $qb->createNamedParameter($share->getShareOwner()), |
|
| 444 | - 'uid_initiator' => $qb->createNamedParameter($share->getSharedBy()), |
|
| 445 | - 'parent' => $qb->createNamedParameter($share->getId()), |
|
| 446 | - 'item_type' => $qb->createNamedParameter($share->getNode() instanceof File ? 'file' : 'folder'), |
|
| 447 | - 'item_source' => $qb->createNamedParameter($share->getNode()->getId()), |
|
| 448 | - 'file_source' => $qb->createNamedParameter($share->getNode()->getId()), |
|
| 449 | - 'file_target' => $qb->createNamedParameter($share->getTarget()), |
|
| 450 | - 'permissions' => $qb->createNamedParameter($share->getPermissions()), |
|
| 451 | - 'stime' => $qb->createNamedParameter($share->getShareTime()->getTimestamp()), |
|
| 452 | - ])->execute(); |
|
| 453 | - } else { |
|
| 454 | - // Already a usergroup share. Update it. |
|
| 455 | - $qb = $this->dbConn->getQueryBuilder(); |
|
| 456 | - $qb->update('share') |
|
| 457 | - ->set('file_target', $qb->createNamedParameter($share->getTarget())) |
|
| 458 | - ->where($qb->expr()->eq('id', $qb->createNamedParameter($data['id']))) |
|
| 459 | - ->execute(); |
|
| 460 | - } |
|
| 461 | - } |
|
| 462 | - |
|
| 463 | - return $share; |
|
| 464 | - } |
|
| 465 | - |
|
| 466 | - public function getSharesInFolder($userId, Folder $node, $reshares) { |
|
| 467 | - $qb = $this->dbConn->getQueryBuilder(); |
|
| 468 | - $qb->select('*') |
|
| 469 | - ->from('share', 's') |
|
| 470 | - ->andWhere($qb->expr()->orX( |
|
| 471 | - $qb->expr()->eq('item_type', $qb->createNamedParameter('file')), |
|
| 472 | - $qb->expr()->eq('item_type', $qb->createNamedParameter('folder')) |
|
| 473 | - )); |
|
| 474 | - |
|
| 475 | - $qb->andWhere($qb->expr()->orX( |
|
| 476 | - $qb->expr()->eq('share_type', $qb->createNamedParameter(\OCP\Share::SHARE_TYPE_USER)), |
|
| 477 | - $qb->expr()->eq('share_type', $qb->createNamedParameter(\OCP\Share::SHARE_TYPE_GROUP)), |
|
| 478 | - $qb->expr()->eq('share_type', $qb->createNamedParameter(\OCP\Share::SHARE_TYPE_LINK)) |
|
| 479 | - )); |
|
| 480 | - |
|
| 481 | - /** |
|
| 482 | - * Reshares for this user are shares where they are the owner. |
|
| 483 | - */ |
|
| 484 | - if ($reshares === false) { |
|
| 485 | - $qb->andWhere($qb->expr()->eq('uid_initiator', $qb->createNamedParameter($userId))); |
|
| 486 | - } else { |
|
| 487 | - $qb->andWhere( |
|
| 488 | - $qb->expr()->orX( |
|
| 489 | - $qb->expr()->eq('uid_owner', $qb->createNamedParameter($userId)), |
|
| 490 | - $qb->expr()->eq('uid_initiator', $qb->createNamedParameter($userId)) |
|
| 491 | - ) |
|
| 492 | - ); |
|
| 493 | - } |
|
| 494 | - |
|
| 495 | - $qb->innerJoin('s', 'filecache' ,'f', $qb->expr()->eq('s.file_source', 'f.fileid')); |
|
| 496 | - $qb->andWhere($qb->expr()->eq('f.parent', $qb->createNamedParameter($node->getId()))); |
|
| 497 | - |
|
| 498 | - $qb->orderBy('id'); |
|
| 499 | - |
|
| 500 | - $cursor = $qb->execute(); |
|
| 501 | - $shares = []; |
|
| 502 | - while ($data = $cursor->fetch()) { |
|
| 503 | - $shares[$data['fileid']][] = $this->createShare($data); |
|
| 504 | - } |
|
| 505 | - $cursor->closeCursor(); |
|
| 506 | - |
|
| 507 | - return $shares; |
|
| 508 | - } |
|
| 509 | - |
|
| 510 | - /** |
|
| 511 | - * @inheritdoc |
|
| 512 | - */ |
|
| 513 | - public function getSharesBy($userId, $shareType, $node, $reshares, $limit, $offset) { |
|
| 514 | - $qb = $this->dbConn->getQueryBuilder(); |
|
| 515 | - $qb->select('*') |
|
| 516 | - ->from('share') |
|
| 517 | - ->andWhere($qb->expr()->orX( |
|
| 518 | - $qb->expr()->eq('item_type', $qb->createNamedParameter('file')), |
|
| 519 | - $qb->expr()->eq('item_type', $qb->createNamedParameter('folder')) |
|
| 520 | - )); |
|
| 521 | - |
|
| 522 | - $qb->andWhere($qb->expr()->eq('share_type', $qb->createNamedParameter($shareType))); |
|
| 523 | - |
|
| 524 | - /** |
|
| 525 | - * Reshares for this user are shares where they are the owner. |
|
| 526 | - */ |
|
| 527 | - if ($reshares === false) { |
|
| 528 | - $qb->andWhere($qb->expr()->eq('uid_initiator', $qb->createNamedParameter($userId))); |
|
| 529 | - } else { |
|
| 530 | - $qb->andWhere( |
|
| 531 | - $qb->expr()->orX( |
|
| 532 | - $qb->expr()->eq('uid_owner', $qb->createNamedParameter($userId)), |
|
| 533 | - $qb->expr()->eq('uid_initiator', $qb->createNamedParameter($userId)) |
|
| 534 | - ) |
|
| 535 | - ); |
|
| 536 | - } |
|
| 537 | - |
|
| 538 | - if ($node !== null) { |
|
| 539 | - $qb->andWhere($qb->expr()->eq('file_source', $qb->createNamedParameter($node->getId()))); |
|
| 540 | - } |
|
| 541 | - |
|
| 542 | - if ($limit !== -1) { |
|
| 543 | - $qb->setMaxResults($limit); |
|
| 544 | - } |
|
| 545 | - |
|
| 546 | - $qb->setFirstResult($offset); |
|
| 547 | - $qb->orderBy('id'); |
|
| 548 | - |
|
| 549 | - $cursor = $qb->execute(); |
|
| 550 | - $shares = []; |
|
| 551 | - while($data = $cursor->fetch()) { |
|
| 552 | - $shares[] = $this->createShare($data); |
|
| 553 | - } |
|
| 554 | - $cursor->closeCursor(); |
|
| 555 | - |
|
| 556 | - return $shares; |
|
| 557 | - } |
|
| 558 | - |
|
| 559 | - /** |
|
| 560 | - * @inheritdoc |
|
| 561 | - */ |
|
| 562 | - public function getShareById($id, $recipientId = null) { |
|
| 563 | - $qb = $this->dbConn->getQueryBuilder(); |
|
| 564 | - |
|
| 565 | - $qb->select('*') |
|
| 566 | - ->from('share') |
|
| 567 | - ->where($qb->expr()->eq('id', $qb->createNamedParameter($id))) |
|
| 568 | - ->andWhere( |
|
| 569 | - $qb->expr()->in( |
|
| 570 | - 'share_type', |
|
| 571 | - $qb->createNamedParameter([ |
|
| 572 | - \OCP\Share::SHARE_TYPE_USER, |
|
| 573 | - \OCP\Share::SHARE_TYPE_GROUP, |
|
| 574 | - \OCP\Share::SHARE_TYPE_LINK, |
|
| 575 | - ], IQueryBuilder::PARAM_INT_ARRAY) |
|
| 576 | - ) |
|
| 577 | - ) |
|
| 578 | - ->andWhere($qb->expr()->orX( |
|
| 579 | - $qb->expr()->eq('item_type', $qb->createNamedParameter('file')), |
|
| 580 | - $qb->expr()->eq('item_type', $qb->createNamedParameter('folder')) |
|
| 581 | - )); |
|
| 582 | - |
|
| 583 | - $cursor = $qb->execute(); |
|
| 584 | - $data = $cursor->fetch(); |
|
| 585 | - $cursor->closeCursor(); |
|
| 586 | - |
|
| 587 | - if ($data === false) { |
|
| 588 | - throw new ShareNotFound(); |
|
| 589 | - } |
|
| 590 | - |
|
| 591 | - try { |
|
| 592 | - $share = $this->createShare($data); |
|
| 593 | - } catch (InvalidShare $e) { |
|
| 594 | - throw new ShareNotFound(); |
|
| 595 | - } |
|
| 596 | - |
|
| 597 | - // If the recipient is set for a group share resolve to that user |
|
| 598 | - if ($recipientId !== null && $share->getShareType() === \OCP\Share::SHARE_TYPE_GROUP) { |
|
| 599 | - $share = $this->resolveGroupShares([$share], $recipientId)[0]; |
|
| 600 | - } |
|
| 601 | - |
|
| 602 | - return $share; |
|
| 603 | - } |
|
| 604 | - |
|
| 605 | - /** |
|
| 606 | - * Get shares for a given path |
|
| 607 | - * |
|
| 608 | - * @param \OCP\Files\Node $path |
|
| 609 | - * @return \OCP\Share\IShare[] |
|
| 610 | - */ |
|
| 611 | - public function getSharesByPath(Node $path) { |
|
| 612 | - $qb = $this->dbConn->getQueryBuilder(); |
|
| 613 | - |
|
| 614 | - $cursor = $qb->select('*') |
|
| 615 | - ->from('share') |
|
| 616 | - ->andWhere($qb->expr()->eq('file_source', $qb->createNamedParameter($path->getId()))) |
|
| 617 | - ->andWhere( |
|
| 618 | - $qb->expr()->orX( |
|
| 619 | - $qb->expr()->eq('share_type', $qb->createNamedParameter(\OCP\Share::SHARE_TYPE_USER)), |
|
| 620 | - $qb->expr()->eq('share_type', $qb->createNamedParameter(\OCP\Share::SHARE_TYPE_GROUP)) |
|
| 621 | - ) |
|
| 622 | - ) |
|
| 623 | - ->andWhere($qb->expr()->orX( |
|
| 624 | - $qb->expr()->eq('item_type', $qb->createNamedParameter('file')), |
|
| 625 | - $qb->expr()->eq('item_type', $qb->createNamedParameter('folder')) |
|
| 626 | - )) |
|
| 627 | - ->execute(); |
|
| 628 | - |
|
| 629 | - $shares = []; |
|
| 630 | - while($data = $cursor->fetch()) { |
|
| 631 | - $shares[] = $this->createShare($data); |
|
| 632 | - } |
|
| 633 | - $cursor->closeCursor(); |
|
| 634 | - |
|
| 635 | - return $shares; |
|
| 636 | - } |
|
| 637 | - |
|
| 638 | - /** |
|
| 639 | - * Returns whether the given database result can be interpreted as |
|
| 640 | - * a share with accessible file (not trashed, not deleted) |
|
| 641 | - */ |
|
| 642 | - private function isAccessibleResult($data) { |
|
| 643 | - // exclude shares leading to deleted file entries |
|
| 644 | - if ($data['fileid'] === null) { |
|
| 645 | - return false; |
|
| 646 | - } |
|
| 647 | - |
|
| 648 | - // exclude shares leading to trashbin on home storages |
|
| 649 | - $pathSections = explode('/', $data['path'], 2); |
|
| 650 | - // FIXME: would not detect rare md5'd home storage case properly |
|
| 651 | - if ($pathSections[0] !== 'files' |
|
| 652 | - && in_array(explode(':', $data['storage_string_id'], 2)[0], array('home', 'object'))) { |
|
| 653 | - return false; |
|
| 654 | - } |
|
| 655 | - return true; |
|
| 656 | - } |
|
| 657 | - |
|
| 658 | - /** |
|
| 659 | - * @inheritdoc |
|
| 660 | - */ |
|
| 661 | - public function getSharedWith($userId, $shareType, $node, $limit, $offset) { |
|
| 662 | - /** @var Share[] $shares */ |
|
| 663 | - $shares = []; |
|
| 664 | - |
|
| 665 | - if ($shareType === \OCP\Share::SHARE_TYPE_USER) { |
|
| 666 | - //Get shares directly with this user |
|
| 667 | - $qb = $this->dbConn->getQueryBuilder(); |
|
| 668 | - $qb->select('s.*', |
|
| 669 | - 'f.fileid', 'f.path', 'f.permissions AS f_permissions', 'f.storage', 'f.path_hash', |
|
| 670 | - 'f.parent AS f_parent', 'f.name', 'f.mimetype', 'f.mimepart', 'f.size', 'f.mtime', 'f.storage_mtime', |
|
| 671 | - 'f.encrypted', 'f.unencrypted_size', 'f.etag', 'f.checksum' |
|
| 672 | - ) |
|
| 673 | - ->selectAlias('st.id', 'storage_string_id') |
|
| 674 | - ->from('share', 's') |
|
| 675 | - ->leftJoin('s', 'filecache', 'f', $qb->expr()->eq('s.file_source', 'f.fileid')) |
|
| 676 | - ->leftJoin('f', 'storages', 'st', $qb->expr()->eq('f.storage', 'st.numeric_id')); |
|
| 677 | - |
|
| 678 | - // Order by id |
|
| 679 | - $qb->orderBy('s.id'); |
|
| 680 | - |
|
| 681 | - // Set limit and offset |
|
| 682 | - if ($limit !== -1) { |
|
| 683 | - $qb->setMaxResults($limit); |
|
| 684 | - } |
|
| 685 | - $qb->setFirstResult($offset); |
|
| 686 | - |
|
| 687 | - $qb->where($qb->expr()->eq('share_type', $qb->createNamedParameter(\OCP\Share::SHARE_TYPE_USER))) |
|
| 688 | - ->andWhere($qb->expr()->eq('share_with', $qb->createNamedParameter($userId))) |
|
| 689 | - ->andWhere($qb->expr()->orX( |
|
| 690 | - $qb->expr()->eq('item_type', $qb->createNamedParameter('file')), |
|
| 691 | - $qb->expr()->eq('item_type', $qb->createNamedParameter('folder')) |
|
| 692 | - )); |
|
| 693 | - |
|
| 694 | - // Filter by node if provided |
|
| 695 | - if ($node !== null) { |
|
| 696 | - $qb->andWhere($qb->expr()->eq('file_source', $qb->createNamedParameter($node->getId()))); |
|
| 697 | - } |
|
| 698 | - |
|
| 699 | - $cursor = $qb->execute(); |
|
| 700 | - |
|
| 701 | - while($data = $cursor->fetch()) { |
|
| 702 | - if ($this->isAccessibleResult($data)) { |
|
| 703 | - $shares[] = $this->createShare($data); |
|
| 704 | - } |
|
| 705 | - } |
|
| 706 | - $cursor->closeCursor(); |
|
| 707 | - |
|
| 708 | - } else if ($shareType === \OCP\Share::SHARE_TYPE_GROUP) { |
|
| 709 | - $user = $this->userManager->get($userId); |
|
| 710 | - $allGroups = $this->groupManager->getUserGroups($user); |
|
| 711 | - |
|
| 712 | - /** @var Share[] $shares2 */ |
|
| 713 | - $shares2 = []; |
|
| 714 | - |
|
| 715 | - $start = 0; |
|
| 716 | - while(true) { |
|
| 717 | - $groups = array_slice($allGroups, $start, 100); |
|
| 718 | - $start += 100; |
|
| 719 | - |
|
| 720 | - if ($groups === []) { |
|
| 721 | - break; |
|
| 722 | - } |
|
| 723 | - |
|
| 724 | - $qb = $this->dbConn->getQueryBuilder(); |
|
| 725 | - $qb->select('s.*', |
|
| 726 | - 'f.fileid', 'f.path', 'f.permissions AS f_permissions', 'f.storage', 'f.path_hash', |
|
| 727 | - 'f.parent AS f_parent', 'f.name', 'f.mimetype', 'f.mimepart', 'f.size', 'f.mtime', 'f.storage_mtime', |
|
| 728 | - 'f.encrypted', 'f.unencrypted_size', 'f.etag', 'f.checksum' |
|
| 729 | - ) |
|
| 730 | - ->selectAlias('st.id', 'storage_string_id') |
|
| 731 | - ->from('share', 's') |
|
| 732 | - ->leftJoin('s', 'filecache', 'f', $qb->expr()->eq('s.file_source', 'f.fileid')) |
|
| 733 | - ->leftJoin('f', 'storages', 'st', $qb->expr()->eq('f.storage', 'st.numeric_id')) |
|
| 734 | - ->orderBy('s.id') |
|
| 735 | - ->setFirstResult(0); |
|
| 736 | - |
|
| 737 | - if ($limit !== -1) { |
|
| 738 | - $qb->setMaxResults($limit - count($shares)); |
|
| 739 | - } |
|
| 740 | - |
|
| 741 | - // Filter by node if provided |
|
| 742 | - if ($node !== null) { |
|
| 743 | - $qb->andWhere($qb->expr()->eq('file_source', $qb->createNamedParameter($node->getId()))); |
|
| 744 | - } |
|
| 745 | - |
|
| 746 | - |
|
| 747 | - $groups = array_filter($groups, function($group) { return $group instanceof IGroup; }); |
|
| 748 | - $groups = array_map(function(IGroup $group) { return $group->getGID(); }, $groups); |
|
| 749 | - |
|
| 750 | - $qb->andWhere($qb->expr()->eq('share_type', $qb->createNamedParameter(\OCP\Share::SHARE_TYPE_GROUP))) |
|
| 751 | - ->andWhere($qb->expr()->in('share_with', $qb->createNamedParameter( |
|
| 752 | - $groups, |
|
| 753 | - IQueryBuilder::PARAM_STR_ARRAY |
|
| 754 | - ))) |
|
| 755 | - ->andWhere($qb->expr()->orX( |
|
| 756 | - $qb->expr()->eq('item_type', $qb->createNamedParameter('file')), |
|
| 757 | - $qb->expr()->eq('item_type', $qb->createNamedParameter('folder')) |
|
| 758 | - )); |
|
| 759 | - |
|
| 760 | - $cursor = $qb->execute(); |
|
| 761 | - while($data = $cursor->fetch()) { |
|
| 762 | - if ($offset > 0) { |
|
| 763 | - $offset--; |
|
| 764 | - continue; |
|
| 765 | - } |
|
| 766 | - |
|
| 767 | - if ($this->isAccessibleResult($data)) { |
|
| 768 | - $shares2[] = $this->createShare($data); |
|
| 769 | - } |
|
| 770 | - } |
|
| 771 | - $cursor->closeCursor(); |
|
| 772 | - } |
|
| 773 | - |
|
| 774 | - /* |
|
| 361 | + if ($data === false) { |
|
| 362 | + $qb = $this->dbConn->getQueryBuilder(); |
|
| 363 | + |
|
| 364 | + $type = $share->getNodeType(); |
|
| 365 | + |
|
| 366 | + //Insert new share |
|
| 367 | + $qb->insert('share') |
|
| 368 | + ->values([ |
|
| 369 | + 'share_type' => $qb->createNamedParameter(self::SHARE_TYPE_USERGROUP), |
|
| 370 | + 'share_with' => $qb->createNamedParameter($recipient), |
|
| 371 | + 'uid_owner' => $qb->createNamedParameter($share->getShareOwner()), |
|
| 372 | + 'uid_initiator' => $qb->createNamedParameter($share->getSharedBy()), |
|
| 373 | + 'parent' => $qb->createNamedParameter($share->getId()), |
|
| 374 | + 'item_type' => $qb->createNamedParameter($type), |
|
| 375 | + 'item_source' => $qb->createNamedParameter($share->getNodeId()), |
|
| 376 | + 'file_source' => $qb->createNamedParameter($share->getNodeId()), |
|
| 377 | + 'file_target' => $qb->createNamedParameter($share->getTarget()), |
|
| 378 | + 'permissions' => $qb->createNamedParameter(0), |
|
| 379 | + 'stime' => $qb->createNamedParameter($share->getShareTime()->getTimestamp()), |
|
| 380 | + ])->execute(); |
|
| 381 | + |
|
| 382 | + } else if ($data['permissions'] !== 0) { |
|
| 383 | + |
|
| 384 | + // Update existing usergroup share |
|
| 385 | + $qb = $this->dbConn->getQueryBuilder(); |
|
| 386 | + $qb->update('share') |
|
| 387 | + ->set('permissions', $qb->createNamedParameter(0)) |
|
| 388 | + ->where($qb->expr()->eq('id', $qb->createNamedParameter($data['id']))) |
|
| 389 | + ->execute(); |
|
| 390 | + } |
|
| 391 | + |
|
| 392 | + } else if ($share->getShareType() === \OCP\Share::SHARE_TYPE_USER) { |
|
| 393 | + |
|
| 394 | + if ($share->getSharedWith() !== $recipient) { |
|
| 395 | + throw new ProviderException('Recipient does not match'); |
|
| 396 | + } |
|
| 397 | + |
|
| 398 | + // We can just delete user and link shares |
|
| 399 | + $this->delete($share); |
|
| 400 | + } else { |
|
| 401 | + throw new ProviderException('Invalid shareType'); |
|
| 402 | + } |
|
| 403 | + } |
|
| 404 | + |
|
| 405 | + /** |
|
| 406 | + * @inheritdoc |
|
| 407 | + */ |
|
| 408 | + public function move(\OCP\Share\IShare $share, $recipient) { |
|
| 409 | + if ($share->getShareType() === \OCP\Share::SHARE_TYPE_USER) { |
|
| 410 | + // Just update the target |
|
| 411 | + $qb = $this->dbConn->getQueryBuilder(); |
|
| 412 | + $qb->update('share') |
|
| 413 | + ->set('file_target', $qb->createNamedParameter($share->getTarget())) |
|
| 414 | + ->where($qb->expr()->eq('id', $qb->createNamedParameter($share->getId()))) |
|
| 415 | + ->execute(); |
|
| 416 | + |
|
| 417 | + } else if ($share->getShareType() === \OCP\Share::SHARE_TYPE_GROUP) { |
|
| 418 | + |
|
| 419 | + // Check if there is a usergroup share |
|
| 420 | + $qb = $this->dbConn->getQueryBuilder(); |
|
| 421 | + $stmt = $qb->select('id') |
|
| 422 | + ->from('share') |
|
| 423 | + ->where($qb->expr()->eq('share_type', $qb->createNamedParameter(self::SHARE_TYPE_USERGROUP))) |
|
| 424 | + ->andWhere($qb->expr()->eq('share_with', $qb->createNamedParameter($recipient))) |
|
| 425 | + ->andWhere($qb->expr()->eq('parent', $qb->createNamedParameter($share->getId()))) |
|
| 426 | + ->andWhere($qb->expr()->orX( |
|
| 427 | + $qb->expr()->eq('item_type', $qb->createNamedParameter('file')), |
|
| 428 | + $qb->expr()->eq('item_type', $qb->createNamedParameter('folder')) |
|
| 429 | + )) |
|
| 430 | + ->setMaxResults(1) |
|
| 431 | + ->execute(); |
|
| 432 | + |
|
| 433 | + $data = $stmt->fetch(); |
|
| 434 | + $stmt->closeCursor(); |
|
| 435 | + |
|
| 436 | + if ($data === false) { |
|
| 437 | + // No usergroup share yet. Create one. |
|
| 438 | + $qb = $this->dbConn->getQueryBuilder(); |
|
| 439 | + $qb->insert('share') |
|
| 440 | + ->values([ |
|
| 441 | + 'share_type' => $qb->createNamedParameter(self::SHARE_TYPE_USERGROUP), |
|
| 442 | + 'share_with' => $qb->createNamedParameter($recipient), |
|
| 443 | + 'uid_owner' => $qb->createNamedParameter($share->getShareOwner()), |
|
| 444 | + 'uid_initiator' => $qb->createNamedParameter($share->getSharedBy()), |
|
| 445 | + 'parent' => $qb->createNamedParameter($share->getId()), |
|
| 446 | + 'item_type' => $qb->createNamedParameter($share->getNode() instanceof File ? 'file' : 'folder'), |
|
| 447 | + 'item_source' => $qb->createNamedParameter($share->getNode()->getId()), |
|
| 448 | + 'file_source' => $qb->createNamedParameter($share->getNode()->getId()), |
|
| 449 | + 'file_target' => $qb->createNamedParameter($share->getTarget()), |
|
| 450 | + 'permissions' => $qb->createNamedParameter($share->getPermissions()), |
|
| 451 | + 'stime' => $qb->createNamedParameter($share->getShareTime()->getTimestamp()), |
|
| 452 | + ])->execute(); |
|
| 453 | + } else { |
|
| 454 | + // Already a usergroup share. Update it. |
|
| 455 | + $qb = $this->dbConn->getQueryBuilder(); |
|
| 456 | + $qb->update('share') |
|
| 457 | + ->set('file_target', $qb->createNamedParameter($share->getTarget())) |
|
| 458 | + ->where($qb->expr()->eq('id', $qb->createNamedParameter($data['id']))) |
|
| 459 | + ->execute(); |
|
| 460 | + } |
|
| 461 | + } |
|
| 462 | + |
|
| 463 | + return $share; |
|
| 464 | + } |
|
| 465 | + |
|
| 466 | + public function getSharesInFolder($userId, Folder $node, $reshares) { |
|
| 467 | + $qb = $this->dbConn->getQueryBuilder(); |
|
| 468 | + $qb->select('*') |
|
| 469 | + ->from('share', 's') |
|
| 470 | + ->andWhere($qb->expr()->orX( |
|
| 471 | + $qb->expr()->eq('item_type', $qb->createNamedParameter('file')), |
|
| 472 | + $qb->expr()->eq('item_type', $qb->createNamedParameter('folder')) |
|
| 473 | + )); |
|
| 474 | + |
|
| 475 | + $qb->andWhere($qb->expr()->orX( |
|
| 476 | + $qb->expr()->eq('share_type', $qb->createNamedParameter(\OCP\Share::SHARE_TYPE_USER)), |
|
| 477 | + $qb->expr()->eq('share_type', $qb->createNamedParameter(\OCP\Share::SHARE_TYPE_GROUP)), |
|
| 478 | + $qb->expr()->eq('share_type', $qb->createNamedParameter(\OCP\Share::SHARE_TYPE_LINK)) |
|
| 479 | + )); |
|
| 480 | + |
|
| 481 | + /** |
|
| 482 | + * Reshares for this user are shares where they are the owner. |
|
| 483 | + */ |
|
| 484 | + if ($reshares === false) { |
|
| 485 | + $qb->andWhere($qb->expr()->eq('uid_initiator', $qb->createNamedParameter($userId))); |
|
| 486 | + } else { |
|
| 487 | + $qb->andWhere( |
|
| 488 | + $qb->expr()->orX( |
|
| 489 | + $qb->expr()->eq('uid_owner', $qb->createNamedParameter($userId)), |
|
| 490 | + $qb->expr()->eq('uid_initiator', $qb->createNamedParameter($userId)) |
|
| 491 | + ) |
|
| 492 | + ); |
|
| 493 | + } |
|
| 494 | + |
|
| 495 | + $qb->innerJoin('s', 'filecache' ,'f', $qb->expr()->eq('s.file_source', 'f.fileid')); |
|
| 496 | + $qb->andWhere($qb->expr()->eq('f.parent', $qb->createNamedParameter($node->getId()))); |
|
| 497 | + |
|
| 498 | + $qb->orderBy('id'); |
|
| 499 | + |
|
| 500 | + $cursor = $qb->execute(); |
|
| 501 | + $shares = []; |
|
| 502 | + while ($data = $cursor->fetch()) { |
|
| 503 | + $shares[$data['fileid']][] = $this->createShare($data); |
|
| 504 | + } |
|
| 505 | + $cursor->closeCursor(); |
|
| 506 | + |
|
| 507 | + return $shares; |
|
| 508 | + } |
|
| 509 | + |
|
| 510 | + /** |
|
| 511 | + * @inheritdoc |
|
| 512 | + */ |
|
| 513 | + public function getSharesBy($userId, $shareType, $node, $reshares, $limit, $offset) { |
|
| 514 | + $qb = $this->dbConn->getQueryBuilder(); |
|
| 515 | + $qb->select('*') |
|
| 516 | + ->from('share') |
|
| 517 | + ->andWhere($qb->expr()->orX( |
|
| 518 | + $qb->expr()->eq('item_type', $qb->createNamedParameter('file')), |
|
| 519 | + $qb->expr()->eq('item_type', $qb->createNamedParameter('folder')) |
|
| 520 | + )); |
|
| 521 | + |
|
| 522 | + $qb->andWhere($qb->expr()->eq('share_type', $qb->createNamedParameter($shareType))); |
|
| 523 | + |
|
| 524 | + /** |
|
| 525 | + * Reshares for this user are shares where they are the owner. |
|
| 526 | + */ |
|
| 527 | + if ($reshares === false) { |
|
| 528 | + $qb->andWhere($qb->expr()->eq('uid_initiator', $qb->createNamedParameter($userId))); |
|
| 529 | + } else { |
|
| 530 | + $qb->andWhere( |
|
| 531 | + $qb->expr()->orX( |
|
| 532 | + $qb->expr()->eq('uid_owner', $qb->createNamedParameter($userId)), |
|
| 533 | + $qb->expr()->eq('uid_initiator', $qb->createNamedParameter($userId)) |
|
| 534 | + ) |
|
| 535 | + ); |
|
| 536 | + } |
|
| 537 | + |
|
| 538 | + if ($node !== null) { |
|
| 539 | + $qb->andWhere($qb->expr()->eq('file_source', $qb->createNamedParameter($node->getId()))); |
|
| 540 | + } |
|
| 541 | + |
|
| 542 | + if ($limit !== -1) { |
|
| 543 | + $qb->setMaxResults($limit); |
|
| 544 | + } |
|
| 545 | + |
|
| 546 | + $qb->setFirstResult($offset); |
|
| 547 | + $qb->orderBy('id'); |
|
| 548 | + |
|
| 549 | + $cursor = $qb->execute(); |
|
| 550 | + $shares = []; |
|
| 551 | + while($data = $cursor->fetch()) { |
|
| 552 | + $shares[] = $this->createShare($data); |
|
| 553 | + } |
|
| 554 | + $cursor->closeCursor(); |
|
| 555 | + |
|
| 556 | + return $shares; |
|
| 557 | + } |
|
| 558 | + |
|
| 559 | + /** |
|
| 560 | + * @inheritdoc |
|
| 561 | + */ |
|
| 562 | + public function getShareById($id, $recipientId = null) { |
|
| 563 | + $qb = $this->dbConn->getQueryBuilder(); |
|
| 564 | + |
|
| 565 | + $qb->select('*') |
|
| 566 | + ->from('share') |
|
| 567 | + ->where($qb->expr()->eq('id', $qb->createNamedParameter($id))) |
|
| 568 | + ->andWhere( |
|
| 569 | + $qb->expr()->in( |
|
| 570 | + 'share_type', |
|
| 571 | + $qb->createNamedParameter([ |
|
| 572 | + \OCP\Share::SHARE_TYPE_USER, |
|
| 573 | + \OCP\Share::SHARE_TYPE_GROUP, |
|
| 574 | + \OCP\Share::SHARE_TYPE_LINK, |
|
| 575 | + ], IQueryBuilder::PARAM_INT_ARRAY) |
|
| 576 | + ) |
|
| 577 | + ) |
|
| 578 | + ->andWhere($qb->expr()->orX( |
|
| 579 | + $qb->expr()->eq('item_type', $qb->createNamedParameter('file')), |
|
| 580 | + $qb->expr()->eq('item_type', $qb->createNamedParameter('folder')) |
|
| 581 | + )); |
|
| 582 | + |
|
| 583 | + $cursor = $qb->execute(); |
|
| 584 | + $data = $cursor->fetch(); |
|
| 585 | + $cursor->closeCursor(); |
|
| 586 | + |
|
| 587 | + if ($data === false) { |
|
| 588 | + throw new ShareNotFound(); |
|
| 589 | + } |
|
| 590 | + |
|
| 591 | + try { |
|
| 592 | + $share = $this->createShare($data); |
|
| 593 | + } catch (InvalidShare $e) { |
|
| 594 | + throw new ShareNotFound(); |
|
| 595 | + } |
|
| 596 | + |
|
| 597 | + // If the recipient is set for a group share resolve to that user |
|
| 598 | + if ($recipientId !== null && $share->getShareType() === \OCP\Share::SHARE_TYPE_GROUP) { |
|
| 599 | + $share = $this->resolveGroupShares([$share], $recipientId)[0]; |
|
| 600 | + } |
|
| 601 | + |
|
| 602 | + return $share; |
|
| 603 | + } |
|
| 604 | + |
|
| 605 | + /** |
|
| 606 | + * Get shares for a given path |
|
| 607 | + * |
|
| 608 | + * @param \OCP\Files\Node $path |
|
| 609 | + * @return \OCP\Share\IShare[] |
|
| 610 | + */ |
|
| 611 | + public function getSharesByPath(Node $path) { |
|
| 612 | + $qb = $this->dbConn->getQueryBuilder(); |
|
| 613 | + |
|
| 614 | + $cursor = $qb->select('*') |
|
| 615 | + ->from('share') |
|
| 616 | + ->andWhere($qb->expr()->eq('file_source', $qb->createNamedParameter($path->getId()))) |
|
| 617 | + ->andWhere( |
|
| 618 | + $qb->expr()->orX( |
|
| 619 | + $qb->expr()->eq('share_type', $qb->createNamedParameter(\OCP\Share::SHARE_TYPE_USER)), |
|
| 620 | + $qb->expr()->eq('share_type', $qb->createNamedParameter(\OCP\Share::SHARE_TYPE_GROUP)) |
|
| 621 | + ) |
|
| 622 | + ) |
|
| 623 | + ->andWhere($qb->expr()->orX( |
|
| 624 | + $qb->expr()->eq('item_type', $qb->createNamedParameter('file')), |
|
| 625 | + $qb->expr()->eq('item_type', $qb->createNamedParameter('folder')) |
|
| 626 | + )) |
|
| 627 | + ->execute(); |
|
| 628 | + |
|
| 629 | + $shares = []; |
|
| 630 | + while($data = $cursor->fetch()) { |
|
| 631 | + $shares[] = $this->createShare($data); |
|
| 632 | + } |
|
| 633 | + $cursor->closeCursor(); |
|
| 634 | + |
|
| 635 | + return $shares; |
|
| 636 | + } |
|
| 637 | + |
|
| 638 | + /** |
|
| 639 | + * Returns whether the given database result can be interpreted as |
|
| 640 | + * a share with accessible file (not trashed, not deleted) |
|
| 641 | + */ |
|
| 642 | + private function isAccessibleResult($data) { |
|
| 643 | + // exclude shares leading to deleted file entries |
|
| 644 | + if ($data['fileid'] === null) { |
|
| 645 | + return false; |
|
| 646 | + } |
|
| 647 | + |
|
| 648 | + // exclude shares leading to trashbin on home storages |
|
| 649 | + $pathSections = explode('/', $data['path'], 2); |
|
| 650 | + // FIXME: would not detect rare md5'd home storage case properly |
|
| 651 | + if ($pathSections[0] !== 'files' |
|
| 652 | + && in_array(explode(':', $data['storage_string_id'], 2)[0], array('home', 'object'))) { |
|
| 653 | + return false; |
|
| 654 | + } |
|
| 655 | + return true; |
|
| 656 | + } |
|
| 657 | + |
|
| 658 | + /** |
|
| 659 | + * @inheritdoc |
|
| 660 | + */ |
|
| 661 | + public function getSharedWith($userId, $shareType, $node, $limit, $offset) { |
|
| 662 | + /** @var Share[] $shares */ |
|
| 663 | + $shares = []; |
|
| 664 | + |
|
| 665 | + if ($shareType === \OCP\Share::SHARE_TYPE_USER) { |
|
| 666 | + //Get shares directly with this user |
|
| 667 | + $qb = $this->dbConn->getQueryBuilder(); |
|
| 668 | + $qb->select('s.*', |
|
| 669 | + 'f.fileid', 'f.path', 'f.permissions AS f_permissions', 'f.storage', 'f.path_hash', |
|
| 670 | + 'f.parent AS f_parent', 'f.name', 'f.mimetype', 'f.mimepart', 'f.size', 'f.mtime', 'f.storage_mtime', |
|
| 671 | + 'f.encrypted', 'f.unencrypted_size', 'f.etag', 'f.checksum' |
|
| 672 | + ) |
|
| 673 | + ->selectAlias('st.id', 'storage_string_id') |
|
| 674 | + ->from('share', 's') |
|
| 675 | + ->leftJoin('s', 'filecache', 'f', $qb->expr()->eq('s.file_source', 'f.fileid')) |
|
| 676 | + ->leftJoin('f', 'storages', 'st', $qb->expr()->eq('f.storage', 'st.numeric_id')); |
|
| 677 | + |
|
| 678 | + // Order by id |
|
| 679 | + $qb->orderBy('s.id'); |
|
| 680 | + |
|
| 681 | + // Set limit and offset |
|
| 682 | + if ($limit !== -1) { |
|
| 683 | + $qb->setMaxResults($limit); |
|
| 684 | + } |
|
| 685 | + $qb->setFirstResult($offset); |
|
| 686 | + |
|
| 687 | + $qb->where($qb->expr()->eq('share_type', $qb->createNamedParameter(\OCP\Share::SHARE_TYPE_USER))) |
|
| 688 | + ->andWhere($qb->expr()->eq('share_with', $qb->createNamedParameter($userId))) |
|
| 689 | + ->andWhere($qb->expr()->orX( |
|
| 690 | + $qb->expr()->eq('item_type', $qb->createNamedParameter('file')), |
|
| 691 | + $qb->expr()->eq('item_type', $qb->createNamedParameter('folder')) |
|
| 692 | + )); |
|
| 693 | + |
|
| 694 | + // Filter by node if provided |
|
| 695 | + if ($node !== null) { |
|
| 696 | + $qb->andWhere($qb->expr()->eq('file_source', $qb->createNamedParameter($node->getId()))); |
|
| 697 | + } |
|
| 698 | + |
|
| 699 | + $cursor = $qb->execute(); |
|
| 700 | + |
|
| 701 | + while($data = $cursor->fetch()) { |
|
| 702 | + if ($this->isAccessibleResult($data)) { |
|
| 703 | + $shares[] = $this->createShare($data); |
|
| 704 | + } |
|
| 705 | + } |
|
| 706 | + $cursor->closeCursor(); |
|
| 707 | + |
|
| 708 | + } else if ($shareType === \OCP\Share::SHARE_TYPE_GROUP) { |
|
| 709 | + $user = $this->userManager->get($userId); |
|
| 710 | + $allGroups = $this->groupManager->getUserGroups($user); |
|
| 711 | + |
|
| 712 | + /** @var Share[] $shares2 */ |
|
| 713 | + $shares2 = []; |
|
| 714 | + |
|
| 715 | + $start = 0; |
|
| 716 | + while(true) { |
|
| 717 | + $groups = array_slice($allGroups, $start, 100); |
|
| 718 | + $start += 100; |
|
| 719 | + |
|
| 720 | + if ($groups === []) { |
|
| 721 | + break; |
|
| 722 | + } |
|
| 723 | + |
|
| 724 | + $qb = $this->dbConn->getQueryBuilder(); |
|
| 725 | + $qb->select('s.*', |
|
| 726 | + 'f.fileid', 'f.path', 'f.permissions AS f_permissions', 'f.storage', 'f.path_hash', |
|
| 727 | + 'f.parent AS f_parent', 'f.name', 'f.mimetype', 'f.mimepart', 'f.size', 'f.mtime', 'f.storage_mtime', |
|
| 728 | + 'f.encrypted', 'f.unencrypted_size', 'f.etag', 'f.checksum' |
|
| 729 | + ) |
|
| 730 | + ->selectAlias('st.id', 'storage_string_id') |
|
| 731 | + ->from('share', 's') |
|
| 732 | + ->leftJoin('s', 'filecache', 'f', $qb->expr()->eq('s.file_source', 'f.fileid')) |
|
| 733 | + ->leftJoin('f', 'storages', 'st', $qb->expr()->eq('f.storage', 'st.numeric_id')) |
|
| 734 | + ->orderBy('s.id') |
|
| 735 | + ->setFirstResult(0); |
|
| 736 | + |
|
| 737 | + if ($limit !== -1) { |
|
| 738 | + $qb->setMaxResults($limit - count($shares)); |
|
| 739 | + } |
|
| 740 | + |
|
| 741 | + // Filter by node if provided |
|
| 742 | + if ($node !== null) { |
|
| 743 | + $qb->andWhere($qb->expr()->eq('file_source', $qb->createNamedParameter($node->getId()))); |
|
| 744 | + } |
|
| 745 | + |
|
| 746 | + |
|
| 747 | + $groups = array_filter($groups, function($group) { return $group instanceof IGroup; }); |
|
| 748 | + $groups = array_map(function(IGroup $group) { return $group->getGID(); }, $groups); |
|
| 749 | + |
|
| 750 | + $qb->andWhere($qb->expr()->eq('share_type', $qb->createNamedParameter(\OCP\Share::SHARE_TYPE_GROUP))) |
|
| 751 | + ->andWhere($qb->expr()->in('share_with', $qb->createNamedParameter( |
|
| 752 | + $groups, |
|
| 753 | + IQueryBuilder::PARAM_STR_ARRAY |
|
| 754 | + ))) |
|
| 755 | + ->andWhere($qb->expr()->orX( |
|
| 756 | + $qb->expr()->eq('item_type', $qb->createNamedParameter('file')), |
|
| 757 | + $qb->expr()->eq('item_type', $qb->createNamedParameter('folder')) |
|
| 758 | + )); |
|
| 759 | + |
|
| 760 | + $cursor = $qb->execute(); |
|
| 761 | + while($data = $cursor->fetch()) { |
|
| 762 | + if ($offset > 0) { |
|
| 763 | + $offset--; |
|
| 764 | + continue; |
|
| 765 | + } |
|
| 766 | + |
|
| 767 | + if ($this->isAccessibleResult($data)) { |
|
| 768 | + $shares2[] = $this->createShare($data); |
|
| 769 | + } |
|
| 770 | + } |
|
| 771 | + $cursor->closeCursor(); |
|
| 772 | + } |
|
| 773 | + |
|
| 774 | + /* |
|
| 775 | 775 | * Resolve all group shares to user specific shares |
| 776 | 776 | */ |
| 777 | - $shares = $this->resolveGroupShares($shares2, $userId); |
|
| 778 | - } else { |
|
| 779 | - throw new BackendError('Invalid backend'); |
|
| 780 | - } |
|
| 781 | - |
|
| 782 | - |
|
| 783 | - return $shares; |
|
| 784 | - } |
|
| 785 | - |
|
| 786 | - /** |
|
| 787 | - * Get a share by token |
|
| 788 | - * |
|
| 789 | - * @param string $token |
|
| 790 | - * @return \OCP\Share\IShare |
|
| 791 | - * @throws ShareNotFound |
|
| 792 | - */ |
|
| 793 | - public function getShareByToken($token) { |
|
| 794 | - $qb = $this->dbConn->getQueryBuilder(); |
|
| 795 | - |
|
| 796 | - $cursor = $qb->select('*') |
|
| 797 | - ->from('share') |
|
| 798 | - ->where($qb->expr()->eq('share_type', $qb->createNamedParameter(\OCP\Share::SHARE_TYPE_LINK))) |
|
| 799 | - ->andWhere($qb->expr()->eq('token', $qb->createNamedParameter($token))) |
|
| 800 | - ->andWhere($qb->expr()->orX( |
|
| 801 | - $qb->expr()->eq('item_type', $qb->createNamedParameter('file')), |
|
| 802 | - $qb->expr()->eq('item_type', $qb->createNamedParameter('folder')) |
|
| 803 | - )) |
|
| 804 | - ->execute(); |
|
| 805 | - |
|
| 806 | - $data = $cursor->fetch(); |
|
| 807 | - |
|
| 808 | - if ($data === false) { |
|
| 809 | - throw new ShareNotFound(); |
|
| 810 | - } |
|
| 811 | - |
|
| 812 | - try { |
|
| 813 | - $share = $this->createShare($data); |
|
| 814 | - } catch (InvalidShare $e) { |
|
| 815 | - throw new ShareNotFound(); |
|
| 816 | - } |
|
| 817 | - |
|
| 818 | - return $share; |
|
| 819 | - } |
|
| 820 | - |
|
| 821 | - /** |
|
| 822 | - * Create a share object from an database row |
|
| 823 | - * |
|
| 824 | - * @param mixed[] $data |
|
| 825 | - * @return \OCP\Share\IShare |
|
| 826 | - * @throws InvalidShare |
|
| 827 | - */ |
|
| 828 | - private function createShare($data) { |
|
| 829 | - $share = new Share($this->rootFolder, $this->userManager); |
|
| 830 | - $share->setId((int)$data['id']) |
|
| 831 | - ->setShareType((int)$data['share_type']) |
|
| 832 | - ->setPermissions((int)$data['permissions']) |
|
| 833 | - ->setTarget($data['file_target']) |
|
| 834 | - ->setMailSend((bool)$data['mail_send']); |
|
| 835 | - |
|
| 836 | - $shareTime = new \DateTime(); |
|
| 837 | - $shareTime->setTimestamp((int)$data['stime']); |
|
| 838 | - $share->setShareTime($shareTime); |
|
| 839 | - |
|
| 840 | - if ($share->getShareType() === \OCP\Share::SHARE_TYPE_USER) { |
|
| 841 | - $share->setSharedWith($data['share_with']); |
|
| 842 | - } else if ($share->getShareType() === \OCP\Share::SHARE_TYPE_GROUP) { |
|
| 843 | - $share->setSharedWith($data['share_with']); |
|
| 844 | - } else if ($share->getShareType() === \OCP\Share::SHARE_TYPE_LINK) { |
|
| 845 | - $share->setPassword($data['password']); |
|
| 846 | - $share->setToken($data['token']); |
|
| 847 | - } |
|
| 848 | - |
|
| 849 | - $share->setSharedBy($data['uid_initiator']); |
|
| 850 | - $share->setShareOwner($data['uid_owner']); |
|
| 851 | - |
|
| 852 | - $share->setNodeId((int)$data['file_source']); |
|
| 853 | - $share->setNodeType($data['item_type']); |
|
| 854 | - |
|
| 855 | - if ($data['expiration'] !== null) { |
|
| 856 | - $expiration = \DateTime::createFromFormat('Y-m-d H:i:s', $data['expiration']); |
|
| 857 | - $share->setExpirationDate($expiration); |
|
| 858 | - } |
|
| 859 | - |
|
| 860 | - if (isset($data['f_permissions'])) { |
|
| 861 | - $entryData = $data; |
|
| 862 | - $entryData['permissions'] = $entryData['f_permissions']; |
|
| 863 | - $entryData['parent'] = $entryData['f_parent']; |
|
| 864 | - $share->setNodeCacheEntry(Cache::cacheEntryFromData($entryData, |
|
| 865 | - \OC::$server->getMimeTypeLoader())); |
|
| 866 | - } |
|
| 867 | - |
|
| 868 | - $share->setProviderId($this->identifier()); |
|
| 869 | - |
|
| 870 | - return $share; |
|
| 871 | - } |
|
| 872 | - |
|
| 873 | - /** |
|
| 874 | - * @param Share[] $shares |
|
| 875 | - * @param $userId |
|
| 876 | - * @return Share[] The updates shares if no update is found for a share return the original |
|
| 877 | - */ |
|
| 878 | - private function resolveGroupShares($shares, $userId) { |
|
| 879 | - $result = []; |
|
| 880 | - |
|
| 881 | - $start = 0; |
|
| 882 | - while(true) { |
|
| 883 | - /** @var Share[] $shareSlice */ |
|
| 884 | - $shareSlice = array_slice($shares, $start, 100); |
|
| 885 | - $start += 100; |
|
| 886 | - |
|
| 887 | - if ($shareSlice === []) { |
|
| 888 | - break; |
|
| 889 | - } |
|
| 890 | - |
|
| 891 | - /** @var int[] $ids */ |
|
| 892 | - $ids = []; |
|
| 893 | - /** @var Share[] $shareMap */ |
|
| 894 | - $shareMap = []; |
|
| 895 | - |
|
| 896 | - foreach ($shareSlice as $share) { |
|
| 897 | - $ids[] = (int)$share->getId(); |
|
| 898 | - $shareMap[$share->getId()] = $share; |
|
| 899 | - } |
|
| 900 | - |
|
| 901 | - $qb = $this->dbConn->getQueryBuilder(); |
|
| 902 | - |
|
| 903 | - $query = $qb->select('*') |
|
| 904 | - ->from('share') |
|
| 905 | - ->where($qb->expr()->in('parent', $qb->createNamedParameter($ids, IQueryBuilder::PARAM_INT_ARRAY))) |
|
| 906 | - ->andWhere($qb->expr()->eq('share_with', $qb->createNamedParameter($userId))) |
|
| 907 | - ->andWhere($qb->expr()->orX( |
|
| 908 | - $qb->expr()->eq('item_type', $qb->createNamedParameter('file')), |
|
| 909 | - $qb->expr()->eq('item_type', $qb->createNamedParameter('folder')) |
|
| 910 | - )); |
|
| 911 | - |
|
| 912 | - $stmt = $query->execute(); |
|
| 913 | - |
|
| 914 | - while($data = $stmt->fetch()) { |
|
| 915 | - $shareMap[$data['parent']]->setPermissions((int)$data['permissions']); |
|
| 916 | - $shareMap[$data['parent']]->setTarget($data['file_target']); |
|
| 917 | - } |
|
| 918 | - |
|
| 919 | - $stmt->closeCursor(); |
|
| 920 | - |
|
| 921 | - foreach ($shareMap as $share) { |
|
| 922 | - $result[] = $share; |
|
| 923 | - } |
|
| 924 | - } |
|
| 925 | - |
|
| 926 | - return $result; |
|
| 927 | - } |
|
| 928 | - |
|
| 929 | - /** |
|
| 930 | - * A user is deleted from the system |
|
| 931 | - * So clean up the relevant shares. |
|
| 932 | - * |
|
| 933 | - * @param string $uid |
|
| 934 | - * @param int $shareType |
|
| 935 | - */ |
|
| 936 | - public function userDeleted($uid, $shareType) { |
|
| 937 | - $qb = $this->dbConn->getQueryBuilder(); |
|
| 938 | - |
|
| 939 | - $qb->delete('share'); |
|
| 940 | - |
|
| 941 | - if ($shareType === \OCP\Share::SHARE_TYPE_USER) { |
|
| 942 | - /* |
|
| 777 | + $shares = $this->resolveGroupShares($shares2, $userId); |
|
| 778 | + } else { |
|
| 779 | + throw new BackendError('Invalid backend'); |
|
| 780 | + } |
|
| 781 | + |
|
| 782 | + |
|
| 783 | + return $shares; |
|
| 784 | + } |
|
| 785 | + |
|
| 786 | + /** |
|
| 787 | + * Get a share by token |
|
| 788 | + * |
|
| 789 | + * @param string $token |
|
| 790 | + * @return \OCP\Share\IShare |
|
| 791 | + * @throws ShareNotFound |
|
| 792 | + */ |
|
| 793 | + public function getShareByToken($token) { |
|
| 794 | + $qb = $this->dbConn->getQueryBuilder(); |
|
| 795 | + |
|
| 796 | + $cursor = $qb->select('*') |
|
| 797 | + ->from('share') |
|
| 798 | + ->where($qb->expr()->eq('share_type', $qb->createNamedParameter(\OCP\Share::SHARE_TYPE_LINK))) |
|
| 799 | + ->andWhere($qb->expr()->eq('token', $qb->createNamedParameter($token))) |
|
| 800 | + ->andWhere($qb->expr()->orX( |
|
| 801 | + $qb->expr()->eq('item_type', $qb->createNamedParameter('file')), |
|
| 802 | + $qb->expr()->eq('item_type', $qb->createNamedParameter('folder')) |
|
| 803 | + )) |
|
| 804 | + ->execute(); |
|
| 805 | + |
|
| 806 | + $data = $cursor->fetch(); |
|
| 807 | + |
|
| 808 | + if ($data === false) { |
|
| 809 | + throw new ShareNotFound(); |
|
| 810 | + } |
|
| 811 | + |
|
| 812 | + try { |
|
| 813 | + $share = $this->createShare($data); |
|
| 814 | + } catch (InvalidShare $e) { |
|
| 815 | + throw new ShareNotFound(); |
|
| 816 | + } |
|
| 817 | + |
|
| 818 | + return $share; |
|
| 819 | + } |
|
| 820 | + |
|
| 821 | + /** |
|
| 822 | + * Create a share object from an database row |
|
| 823 | + * |
|
| 824 | + * @param mixed[] $data |
|
| 825 | + * @return \OCP\Share\IShare |
|
| 826 | + * @throws InvalidShare |
|
| 827 | + */ |
|
| 828 | + private function createShare($data) { |
|
| 829 | + $share = new Share($this->rootFolder, $this->userManager); |
|
| 830 | + $share->setId((int)$data['id']) |
|
| 831 | + ->setShareType((int)$data['share_type']) |
|
| 832 | + ->setPermissions((int)$data['permissions']) |
|
| 833 | + ->setTarget($data['file_target']) |
|
| 834 | + ->setMailSend((bool)$data['mail_send']); |
|
| 835 | + |
|
| 836 | + $shareTime = new \DateTime(); |
|
| 837 | + $shareTime->setTimestamp((int)$data['stime']); |
|
| 838 | + $share->setShareTime($shareTime); |
|
| 839 | + |
|
| 840 | + if ($share->getShareType() === \OCP\Share::SHARE_TYPE_USER) { |
|
| 841 | + $share->setSharedWith($data['share_with']); |
|
| 842 | + } else if ($share->getShareType() === \OCP\Share::SHARE_TYPE_GROUP) { |
|
| 843 | + $share->setSharedWith($data['share_with']); |
|
| 844 | + } else if ($share->getShareType() === \OCP\Share::SHARE_TYPE_LINK) { |
|
| 845 | + $share->setPassword($data['password']); |
|
| 846 | + $share->setToken($data['token']); |
|
| 847 | + } |
|
| 848 | + |
|
| 849 | + $share->setSharedBy($data['uid_initiator']); |
|
| 850 | + $share->setShareOwner($data['uid_owner']); |
|
| 851 | + |
|
| 852 | + $share->setNodeId((int)$data['file_source']); |
|
| 853 | + $share->setNodeType($data['item_type']); |
|
| 854 | + |
|
| 855 | + if ($data['expiration'] !== null) { |
|
| 856 | + $expiration = \DateTime::createFromFormat('Y-m-d H:i:s', $data['expiration']); |
|
| 857 | + $share->setExpirationDate($expiration); |
|
| 858 | + } |
|
| 859 | + |
|
| 860 | + if (isset($data['f_permissions'])) { |
|
| 861 | + $entryData = $data; |
|
| 862 | + $entryData['permissions'] = $entryData['f_permissions']; |
|
| 863 | + $entryData['parent'] = $entryData['f_parent']; |
|
| 864 | + $share->setNodeCacheEntry(Cache::cacheEntryFromData($entryData, |
|
| 865 | + \OC::$server->getMimeTypeLoader())); |
|
| 866 | + } |
|
| 867 | + |
|
| 868 | + $share->setProviderId($this->identifier()); |
|
| 869 | + |
|
| 870 | + return $share; |
|
| 871 | + } |
|
| 872 | + |
|
| 873 | + /** |
|
| 874 | + * @param Share[] $shares |
|
| 875 | + * @param $userId |
|
| 876 | + * @return Share[] The updates shares if no update is found for a share return the original |
|
| 877 | + */ |
|
| 878 | + private function resolveGroupShares($shares, $userId) { |
|
| 879 | + $result = []; |
|
| 880 | + |
|
| 881 | + $start = 0; |
|
| 882 | + while(true) { |
|
| 883 | + /** @var Share[] $shareSlice */ |
|
| 884 | + $shareSlice = array_slice($shares, $start, 100); |
|
| 885 | + $start += 100; |
|
| 886 | + |
|
| 887 | + if ($shareSlice === []) { |
|
| 888 | + break; |
|
| 889 | + } |
|
| 890 | + |
|
| 891 | + /** @var int[] $ids */ |
|
| 892 | + $ids = []; |
|
| 893 | + /** @var Share[] $shareMap */ |
|
| 894 | + $shareMap = []; |
|
| 895 | + |
|
| 896 | + foreach ($shareSlice as $share) { |
|
| 897 | + $ids[] = (int)$share->getId(); |
|
| 898 | + $shareMap[$share->getId()] = $share; |
|
| 899 | + } |
|
| 900 | + |
|
| 901 | + $qb = $this->dbConn->getQueryBuilder(); |
|
| 902 | + |
|
| 903 | + $query = $qb->select('*') |
|
| 904 | + ->from('share') |
|
| 905 | + ->where($qb->expr()->in('parent', $qb->createNamedParameter($ids, IQueryBuilder::PARAM_INT_ARRAY))) |
|
| 906 | + ->andWhere($qb->expr()->eq('share_with', $qb->createNamedParameter($userId))) |
|
| 907 | + ->andWhere($qb->expr()->orX( |
|
| 908 | + $qb->expr()->eq('item_type', $qb->createNamedParameter('file')), |
|
| 909 | + $qb->expr()->eq('item_type', $qb->createNamedParameter('folder')) |
|
| 910 | + )); |
|
| 911 | + |
|
| 912 | + $stmt = $query->execute(); |
|
| 913 | + |
|
| 914 | + while($data = $stmt->fetch()) { |
|
| 915 | + $shareMap[$data['parent']]->setPermissions((int)$data['permissions']); |
|
| 916 | + $shareMap[$data['parent']]->setTarget($data['file_target']); |
|
| 917 | + } |
|
| 918 | + |
|
| 919 | + $stmt->closeCursor(); |
|
| 920 | + |
|
| 921 | + foreach ($shareMap as $share) { |
|
| 922 | + $result[] = $share; |
|
| 923 | + } |
|
| 924 | + } |
|
| 925 | + |
|
| 926 | + return $result; |
|
| 927 | + } |
|
| 928 | + |
|
| 929 | + /** |
|
| 930 | + * A user is deleted from the system |
|
| 931 | + * So clean up the relevant shares. |
|
| 932 | + * |
|
| 933 | + * @param string $uid |
|
| 934 | + * @param int $shareType |
|
| 935 | + */ |
|
| 936 | + public function userDeleted($uid, $shareType) { |
|
| 937 | + $qb = $this->dbConn->getQueryBuilder(); |
|
| 938 | + |
|
| 939 | + $qb->delete('share'); |
|
| 940 | + |
|
| 941 | + if ($shareType === \OCP\Share::SHARE_TYPE_USER) { |
|
| 942 | + /* |
|
| 943 | 943 | * Delete all user shares that are owned by this user |
| 944 | 944 | * or that are received by this user |
| 945 | 945 | */ |
| 946 | 946 | |
| 947 | - $qb->where($qb->expr()->eq('share_type', $qb->createNamedParameter(\OCP\Share::SHARE_TYPE_USER))); |
|
| 947 | + $qb->where($qb->expr()->eq('share_type', $qb->createNamedParameter(\OCP\Share::SHARE_TYPE_USER))); |
|
| 948 | 948 | |
| 949 | - $qb->andWhere( |
|
| 950 | - $qb->expr()->orX( |
|
| 951 | - $qb->expr()->eq('uid_owner', $qb->createNamedParameter($uid)), |
|
| 952 | - $qb->expr()->eq('share_with', $qb->createNamedParameter($uid)) |
|
| 953 | - ) |
|
| 954 | - ); |
|
| 955 | - } else if ($shareType === \OCP\Share::SHARE_TYPE_GROUP) { |
|
| 956 | - /* |
|
| 949 | + $qb->andWhere( |
|
| 950 | + $qb->expr()->orX( |
|
| 951 | + $qb->expr()->eq('uid_owner', $qb->createNamedParameter($uid)), |
|
| 952 | + $qb->expr()->eq('share_with', $qb->createNamedParameter($uid)) |
|
| 953 | + ) |
|
| 954 | + ); |
|
| 955 | + } else if ($shareType === \OCP\Share::SHARE_TYPE_GROUP) { |
|
| 956 | + /* |
|
| 957 | 957 | * Delete all group shares that are owned by this user |
| 958 | 958 | * Or special user group shares that are received by this user |
| 959 | 959 | */ |
| 960 | - $qb->where( |
|
| 961 | - $qb->expr()->andX( |
|
| 962 | - $qb->expr()->orX( |
|
| 963 | - $qb->expr()->eq('share_type', $qb->createNamedParameter(\OCP\Share::SHARE_TYPE_GROUP)), |
|
| 964 | - $qb->expr()->eq('share_type', $qb->createNamedParameter(self::SHARE_TYPE_USERGROUP)) |
|
| 965 | - ), |
|
| 966 | - $qb->expr()->eq('uid_owner', $qb->createNamedParameter($uid)) |
|
| 967 | - ) |
|
| 968 | - ); |
|
| 969 | - |
|
| 970 | - $qb->orWhere( |
|
| 971 | - $qb->expr()->andX( |
|
| 972 | - $qb->expr()->eq('share_type', $qb->createNamedParameter(self::SHARE_TYPE_USERGROUP)), |
|
| 973 | - $qb->expr()->eq('share_with', $qb->createNamedParameter($uid)) |
|
| 974 | - ) |
|
| 975 | - ); |
|
| 976 | - } else if ($shareType === \OCP\Share::SHARE_TYPE_LINK) { |
|
| 977 | - /* |
|
| 960 | + $qb->where( |
|
| 961 | + $qb->expr()->andX( |
|
| 962 | + $qb->expr()->orX( |
|
| 963 | + $qb->expr()->eq('share_type', $qb->createNamedParameter(\OCP\Share::SHARE_TYPE_GROUP)), |
|
| 964 | + $qb->expr()->eq('share_type', $qb->createNamedParameter(self::SHARE_TYPE_USERGROUP)) |
|
| 965 | + ), |
|
| 966 | + $qb->expr()->eq('uid_owner', $qb->createNamedParameter($uid)) |
|
| 967 | + ) |
|
| 968 | + ); |
|
| 969 | + |
|
| 970 | + $qb->orWhere( |
|
| 971 | + $qb->expr()->andX( |
|
| 972 | + $qb->expr()->eq('share_type', $qb->createNamedParameter(self::SHARE_TYPE_USERGROUP)), |
|
| 973 | + $qb->expr()->eq('share_with', $qb->createNamedParameter($uid)) |
|
| 974 | + ) |
|
| 975 | + ); |
|
| 976 | + } else if ($shareType === \OCP\Share::SHARE_TYPE_LINK) { |
|
| 977 | + /* |
|
| 978 | 978 | * Delete all link shares owned by this user. |
| 979 | 979 | * And all link shares initiated by this user (until #22327 is in) |
| 980 | 980 | */ |
| 981 | - $qb->where($qb->expr()->eq('share_type', $qb->createNamedParameter(\OCP\Share::SHARE_TYPE_LINK))); |
|
| 982 | - |
|
| 983 | - $qb->andWhere( |
|
| 984 | - $qb->expr()->orX( |
|
| 985 | - $qb->expr()->eq('uid_owner', $qb->createNamedParameter($uid)), |
|
| 986 | - $qb->expr()->eq('uid_initiator', $qb->createNamedParameter($uid)) |
|
| 987 | - ) |
|
| 988 | - ); |
|
| 989 | - } |
|
| 990 | - |
|
| 991 | - $qb->execute(); |
|
| 992 | - } |
|
| 993 | - |
|
| 994 | - /** |
|
| 995 | - * Delete all shares received by this group. As well as any custom group |
|
| 996 | - * shares for group members. |
|
| 997 | - * |
|
| 998 | - * @param string $gid |
|
| 999 | - */ |
|
| 1000 | - public function groupDeleted($gid) { |
|
| 1001 | - /* |
|
| 981 | + $qb->where($qb->expr()->eq('share_type', $qb->createNamedParameter(\OCP\Share::SHARE_TYPE_LINK))); |
|
| 982 | + |
|
| 983 | + $qb->andWhere( |
|
| 984 | + $qb->expr()->orX( |
|
| 985 | + $qb->expr()->eq('uid_owner', $qb->createNamedParameter($uid)), |
|
| 986 | + $qb->expr()->eq('uid_initiator', $qb->createNamedParameter($uid)) |
|
| 987 | + ) |
|
| 988 | + ); |
|
| 989 | + } |
|
| 990 | + |
|
| 991 | + $qb->execute(); |
|
| 992 | + } |
|
| 993 | + |
|
| 994 | + /** |
|
| 995 | + * Delete all shares received by this group. As well as any custom group |
|
| 996 | + * shares for group members. |
|
| 997 | + * |
|
| 998 | + * @param string $gid |
|
| 999 | + */ |
|
| 1000 | + public function groupDeleted($gid) { |
|
| 1001 | + /* |
|
| 1002 | 1002 | * First delete all custom group shares for group members |
| 1003 | 1003 | */ |
| 1004 | - $qb = $this->dbConn->getQueryBuilder(); |
|
| 1005 | - $qb->select('id') |
|
| 1006 | - ->from('share') |
|
| 1007 | - ->where($qb->expr()->eq('share_type', $qb->createNamedParameter(\OCP\Share::SHARE_TYPE_GROUP))) |
|
| 1008 | - ->andWhere($qb->expr()->eq('share_with', $qb->createNamedParameter($gid))); |
|
| 1009 | - |
|
| 1010 | - $cursor = $qb->execute(); |
|
| 1011 | - $ids = []; |
|
| 1012 | - while($row = $cursor->fetch()) { |
|
| 1013 | - $ids[] = (int)$row['id']; |
|
| 1014 | - } |
|
| 1015 | - $cursor->closeCursor(); |
|
| 1016 | - |
|
| 1017 | - if (!empty($ids)) { |
|
| 1018 | - $chunks = array_chunk($ids, 100); |
|
| 1019 | - foreach ($chunks as $chunk) { |
|
| 1020 | - $qb->delete('share') |
|
| 1021 | - ->where($qb->expr()->eq('share_type', $qb->createNamedParameter(self::SHARE_TYPE_USERGROUP))) |
|
| 1022 | - ->andWhere($qb->expr()->in('parent', $qb->createNamedParameter($chunk, IQueryBuilder::PARAM_INT_ARRAY))); |
|
| 1023 | - $qb->execute(); |
|
| 1024 | - } |
|
| 1025 | - } |
|
| 1026 | - |
|
| 1027 | - /* |
|
| 1004 | + $qb = $this->dbConn->getQueryBuilder(); |
|
| 1005 | + $qb->select('id') |
|
| 1006 | + ->from('share') |
|
| 1007 | + ->where($qb->expr()->eq('share_type', $qb->createNamedParameter(\OCP\Share::SHARE_TYPE_GROUP))) |
|
| 1008 | + ->andWhere($qb->expr()->eq('share_with', $qb->createNamedParameter($gid))); |
|
| 1009 | + |
|
| 1010 | + $cursor = $qb->execute(); |
|
| 1011 | + $ids = []; |
|
| 1012 | + while($row = $cursor->fetch()) { |
|
| 1013 | + $ids[] = (int)$row['id']; |
|
| 1014 | + } |
|
| 1015 | + $cursor->closeCursor(); |
|
| 1016 | + |
|
| 1017 | + if (!empty($ids)) { |
|
| 1018 | + $chunks = array_chunk($ids, 100); |
|
| 1019 | + foreach ($chunks as $chunk) { |
|
| 1020 | + $qb->delete('share') |
|
| 1021 | + ->where($qb->expr()->eq('share_type', $qb->createNamedParameter(self::SHARE_TYPE_USERGROUP))) |
|
| 1022 | + ->andWhere($qb->expr()->in('parent', $qb->createNamedParameter($chunk, IQueryBuilder::PARAM_INT_ARRAY))); |
|
| 1023 | + $qb->execute(); |
|
| 1024 | + } |
|
| 1025 | + } |
|
| 1026 | + |
|
| 1027 | + /* |
|
| 1028 | 1028 | * Now delete all the group shares |
| 1029 | 1029 | */ |
| 1030 | - $qb = $this->dbConn->getQueryBuilder(); |
|
| 1031 | - $qb->delete('share') |
|
| 1032 | - ->where($qb->expr()->eq('share_type', $qb->createNamedParameter(\OCP\Share::SHARE_TYPE_GROUP))) |
|
| 1033 | - ->andWhere($qb->expr()->eq('share_with', $qb->createNamedParameter($gid))); |
|
| 1034 | - $qb->execute(); |
|
| 1035 | - } |
|
| 1036 | - |
|
| 1037 | - /** |
|
| 1038 | - * Delete custom group shares to this group for this user |
|
| 1039 | - * |
|
| 1040 | - * @param string $uid |
|
| 1041 | - * @param string $gid |
|
| 1042 | - */ |
|
| 1043 | - public function userDeletedFromGroup($uid, $gid) { |
|
| 1044 | - /* |
|
| 1030 | + $qb = $this->dbConn->getQueryBuilder(); |
|
| 1031 | + $qb->delete('share') |
|
| 1032 | + ->where($qb->expr()->eq('share_type', $qb->createNamedParameter(\OCP\Share::SHARE_TYPE_GROUP))) |
|
| 1033 | + ->andWhere($qb->expr()->eq('share_with', $qb->createNamedParameter($gid))); |
|
| 1034 | + $qb->execute(); |
|
| 1035 | + } |
|
| 1036 | + |
|
| 1037 | + /** |
|
| 1038 | + * Delete custom group shares to this group for this user |
|
| 1039 | + * |
|
| 1040 | + * @param string $uid |
|
| 1041 | + * @param string $gid |
|
| 1042 | + */ |
|
| 1043 | + public function userDeletedFromGroup($uid, $gid) { |
|
| 1044 | + /* |
|
| 1045 | 1045 | * Get all group shares |
| 1046 | 1046 | */ |
| 1047 | - $qb = $this->dbConn->getQueryBuilder(); |
|
| 1048 | - $qb->select('id') |
|
| 1049 | - ->from('share') |
|
| 1050 | - ->where($qb->expr()->eq('share_type', $qb->createNamedParameter(\OCP\Share::SHARE_TYPE_GROUP))) |
|
| 1051 | - ->andWhere($qb->expr()->eq('share_with', $qb->createNamedParameter($gid))); |
|
| 1052 | - |
|
| 1053 | - $cursor = $qb->execute(); |
|
| 1054 | - $ids = []; |
|
| 1055 | - while($row = $cursor->fetch()) { |
|
| 1056 | - $ids[] = (int)$row['id']; |
|
| 1057 | - } |
|
| 1058 | - $cursor->closeCursor(); |
|
| 1059 | - |
|
| 1060 | - if (!empty($ids)) { |
|
| 1061 | - $chunks = array_chunk($ids, 100); |
|
| 1062 | - foreach ($chunks as $chunk) { |
|
| 1063 | - /* |
|
| 1047 | + $qb = $this->dbConn->getQueryBuilder(); |
|
| 1048 | + $qb->select('id') |
|
| 1049 | + ->from('share') |
|
| 1050 | + ->where($qb->expr()->eq('share_type', $qb->createNamedParameter(\OCP\Share::SHARE_TYPE_GROUP))) |
|
| 1051 | + ->andWhere($qb->expr()->eq('share_with', $qb->createNamedParameter($gid))); |
|
| 1052 | + |
|
| 1053 | + $cursor = $qb->execute(); |
|
| 1054 | + $ids = []; |
|
| 1055 | + while($row = $cursor->fetch()) { |
|
| 1056 | + $ids[] = (int)$row['id']; |
|
| 1057 | + } |
|
| 1058 | + $cursor->closeCursor(); |
|
| 1059 | + |
|
| 1060 | + if (!empty($ids)) { |
|
| 1061 | + $chunks = array_chunk($ids, 100); |
|
| 1062 | + foreach ($chunks as $chunk) { |
|
| 1063 | + /* |
|
| 1064 | 1064 | * Delete all special shares wit this users for the found group shares |
| 1065 | 1065 | */ |
| 1066 | - $qb->delete('share') |
|
| 1067 | - ->where($qb->expr()->eq('share_type', $qb->createNamedParameter(self::SHARE_TYPE_USERGROUP))) |
|
| 1068 | - ->andWhere($qb->expr()->eq('share_with', $qb->createNamedParameter($uid))) |
|
| 1069 | - ->andWhere($qb->expr()->in('parent', $qb->createNamedParameter($chunk, IQueryBuilder::PARAM_INT_ARRAY))); |
|
| 1070 | - $qb->execute(); |
|
| 1071 | - } |
|
| 1072 | - } |
|
| 1073 | - } |
|
| 1074 | - |
|
| 1075 | - /** |
|
| 1076 | - * @inheritdoc |
|
| 1077 | - */ |
|
| 1078 | - public function getAccessList($nodes, $currentAccess) { |
|
| 1079 | - $ids = []; |
|
| 1080 | - foreach ($nodes as $node) { |
|
| 1081 | - $ids[] = $node->getId(); |
|
| 1082 | - } |
|
| 1083 | - |
|
| 1084 | - $qb = $this->dbConn->getQueryBuilder(); |
|
| 1085 | - |
|
| 1086 | - $or = $qb->expr()->orX( |
|
| 1087 | - $qb->expr()->eq('share_type', $qb->createNamedParameter(\OCP\Share::SHARE_TYPE_USER)), |
|
| 1088 | - $qb->expr()->eq('share_type', $qb->createNamedParameter(\OCP\Share::SHARE_TYPE_GROUP)), |
|
| 1089 | - $qb->expr()->eq('share_type', $qb->createNamedParameter(\OCP\Share::SHARE_TYPE_LINK)) |
|
| 1090 | - ); |
|
| 1091 | - |
|
| 1092 | - if ($currentAccess) { |
|
| 1093 | - $or->add($qb->expr()->eq('share_type', $qb->createNamedParameter(self::SHARE_TYPE_USERGROUP))); |
|
| 1094 | - } |
|
| 1095 | - |
|
| 1096 | - $qb->select('id', 'parent', 'share_type', 'share_with', 'file_source', 'file_target', 'permissions') |
|
| 1097 | - ->from('share') |
|
| 1098 | - ->where( |
|
| 1099 | - $or |
|
| 1100 | - ) |
|
| 1101 | - ->andWhere($qb->expr()->in('file_source', $qb->createNamedParameter($ids, IQueryBuilder::PARAM_INT_ARRAY))) |
|
| 1102 | - ->andWhere($qb->expr()->orX( |
|
| 1103 | - $qb->expr()->eq('item_type', $qb->createNamedParameter('file')), |
|
| 1104 | - $qb->expr()->eq('item_type', $qb->createNamedParameter('folder')) |
|
| 1105 | - )); |
|
| 1106 | - $cursor = $qb->execute(); |
|
| 1107 | - |
|
| 1108 | - $users = []; |
|
| 1109 | - $link = false; |
|
| 1110 | - while($row = $cursor->fetch()) { |
|
| 1111 | - $type = (int)$row['share_type']; |
|
| 1112 | - if ($type === \OCP\Share::SHARE_TYPE_USER) { |
|
| 1113 | - $uid = $row['share_with']; |
|
| 1114 | - $users[$uid] = isset($users[$uid]) ? $users[$uid] : []; |
|
| 1115 | - $users[$uid][$row['id']] = $row; |
|
| 1116 | - } else if ($type === \OCP\Share::SHARE_TYPE_GROUP) { |
|
| 1117 | - $gid = $row['share_with']; |
|
| 1118 | - $group = $this->groupManager->get($gid); |
|
| 1119 | - |
|
| 1120 | - if ($group === null) { |
|
| 1121 | - continue; |
|
| 1122 | - } |
|
| 1123 | - |
|
| 1124 | - $userList = $group->getUsers(); |
|
| 1125 | - foreach ($userList as $user) { |
|
| 1126 | - $uid = $user->getUID(); |
|
| 1127 | - $users[$uid] = isset($users[$uid]) ? $users[$uid] : []; |
|
| 1128 | - $users[$uid][$row['id']] = $row; |
|
| 1129 | - } |
|
| 1130 | - } else if ($type === \OCP\Share::SHARE_TYPE_LINK) { |
|
| 1131 | - $link = true; |
|
| 1132 | - } else if ($type === self::SHARE_TYPE_USERGROUP && $currentAccess === true) { |
|
| 1133 | - $uid = $row['share_with']; |
|
| 1134 | - $users[$uid] = isset($users[$uid]) ? $users[$uid] : []; |
|
| 1135 | - $users[$uid][$row['id']] = $row; |
|
| 1136 | - } |
|
| 1137 | - } |
|
| 1138 | - $cursor->closeCursor(); |
|
| 1139 | - |
|
| 1140 | - if ($currentAccess === true) { |
|
| 1141 | - $users = array_map([$this, 'filterSharesOfUser'], $users); |
|
| 1142 | - $users = array_filter($users); |
|
| 1143 | - } else { |
|
| 1144 | - $users = array_keys($users); |
|
| 1145 | - } |
|
| 1146 | - |
|
| 1147 | - return ['users' => $users, 'public' => $link]; |
|
| 1148 | - } |
|
| 1149 | - |
|
| 1150 | - /** |
|
| 1151 | - * For each user the path with the fewest slashes is returned |
|
| 1152 | - * @param array $shares |
|
| 1153 | - * @return array |
|
| 1154 | - */ |
|
| 1155 | - protected function filterSharesOfUser(array $shares) { |
|
| 1156 | - // Group shares when the user has a share exception |
|
| 1157 | - foreach ($shares as $id => $share) { |
|
| 1158 | - $type = (int) $share['share_type']; |
|
| 1159 | - $permissions = (int) $share['permissions']; |
|
| 1160 | - |
|
| 1161 | - if ($type === self::SHARE_TYPE_USERGROUP) { |
|
| 1162 | - unset($shares[$share['parent']]); |
|
| 1163 | - |
|
| 1164 | - if ($permissions === 0) { |
|
| 1165 | - unset($shares[$id]); |
|
| 1166 | - } |
|
| 1167 | - } |
|
| 1168 | - } |
|
| 1169 | - |
|
| 1170 | - $best = []; |
|
| 1171 | - $bestDepth = 0; |
|
| 1172 | - foreach ($shares as $id => $share) { |
|
| 1173 | - $depth = substr_count($share['file_target'], '/'); |
|
| 1174 | - if (empty($best) || $depth < $bestDepth) { |
|
| 1175 | - $bestDepth = $depth; |
|
| 1176 | - $best = [ |
|
| 1177 | - 'node_id' => $share['file_source'], |
|
| 1178 | - 'node_path' => $share['file_target'], |
|
| 1179 | - ]; |
|
| 1180 | - } |
|
| 1181 | - } |
|
| 1182 | - |
|
| 1183 | - return $best; |
|
| 1184 | - } |
|
| 1066 | + $qb->delete('share') |
|
| 1067 | + ->where($qb->expr()->eq('share_type', $qb->createNamedParameter(self::SHARE_TYPE_USERGROUP))) |
|
| 1068 | + ->andWhere($qb->expr()->eq('share_with', $qb->createNamedParameter($uid))) |
|
| 1069 | + ->andWhere($qb->expr()->in('parent', $qb->createNamedParameter($chunk, IQueryBuilder::PARAM_INT_ARRAY))); |
|
| 1070 | + $qb->execute(); |
|
| 1071 | + } |
|
| 1072 | + } |
|
| 1073 | + } |
|
| 1074 | + |
|
| 1075 | + /** |
|
| 1076 | + * @inheritdoc |
|
| 1077 | + */ |
|
| 1078 | + public function getAccessList($nodes, $currentAccess) { |
|
| 1079 | + $ids = []; |
|
| 1080 | + foreach ($nodes as $node) { |
|
| 1081 | + $ids[] = $node->getId(); |
|
| 1082 | + } |
|
| 1083 | + |
|
| 1084 | + $qb = $this->dbConn->getQueryBuilder(); |
|
| 1085 | + |
|
| 1086 | + $or = $qb->expr()->orX( |
|
| 1087 | + $qb->expr()->eq('share_type', $qb->createNamedParameter(\OCP\Share::SHARE_TYPE_USER)), |
|
| 1088 | + $qb->expr()->eq('share_type', $qb->createNamedParameter(\OCP\Share::SHARE_TYPE_GROUP)), |
|
| 1089 | + $qb->expr()->eq('share_type', $qb->createNamedParameter(\OCP\Share::SHARE_TYPE_LINK)) |
|
| 1090 | + ); |
|
| 1091 | + |
|
| 1092 | + if ($currentAccess) { |
|
| 1093 | + $or->add($qb->expr()->eq('share_type', $qb->createNamedParameter(self::SHARE_TYPE_USERGROUP))); |
|
| 1094 | + } |
|
| 1095 | + |
|
| 1096 | + $qb->select('id', 'parent', 'share_type', 'share_with', 'file_source', 'file_target', 'permissions') |
|
| 1097 | + ->from('share') |
|
| 1098 | + ->where( |
|
| 1099 | + $or |
|
| 1100 | + ) |
|
| 1101 | + ->andWhere($qb->expr()->in('file_source', $qb->createNamedParameter($ids, IQueryBuilder::PARAM_INT_ARRAY))) |
|
| 1102 | + ->andWhere($qb->expr()->orX( |
|
| 1103 | + $qb->expr()->eq('item_type', $qb->createNamedParameter('file')), |
|
| 1104 | + $qb->expr()->eq('item_type', $qb->createNamedParameter('folder')) |
|
| 1105 | + )); |
|
| 1106 | + $cursor = $qb->execute(); |
|
| 1107 | + |
|
| 1108 | + $users = []; |
|
| 1109 | + $link = false; |
|
| 1110 | + while($row = $cursor->fetch()) { |
|
| 1111 | + $type = (int)$row['share_type']; |
|
| 1112 | + if ($type === \OCP\Share::SHARE_TYPE_USER) { |
|
| 1113 | + $uid = $row['share_with']; |
|
| 1114 | + $users[$uid] = isset($users[$uid]) ? $users[$uid] : []; |
|
| 1115 | + $users[$uid][$row['id']] = $row; |
|
| 1116 | + } else if ($type === \OCP\Share::SHARE_TYPE_GROUP) { |
|
| 1117 | + $gid = $row['share_with']; |
|
| 1118 | + $group = $this->groupManager->get($gid); |
|
| 1119 | + |
|
| 1120 | + if ($group === null) { |
|
| 1121 | + continue; |
|
| 1122 | + } |
|
| 1123 | + |
|
| 1124 | + $userList = $group->getUsers(); |
|
| 1125 | + foreach ($userList as $user) { |
|
| 1126 | + $uid = $user->getUID(); |
|
| 1127 | + $users[$uid] = isset($users[$uid]) ? $users[$uid] : []; |
|
| 1128 | + $users[$uid][$row['id']] = $row; |
|
| 1129 | + } |
|
| 1130 | + } else if ($type === \OCP\Share::SHARE_TYPE_LINK) { |
|
| 1131 | + $link = true; |
|
| 1132 | + } else if ($type === self::SHARE_TYPE_USERGROUP && $currentAccess === true) { |
|
| 1133 | + $uid = $row['share_with']; |
|
| 1134 | + $users[$uid] = isset($users[$uid]) ? $users[$uid] : []; |
|
| 1135 | + $users[$uid][$row['id']] = $row; |
|
| 1136 | + } |
|
| 1137 | + } |
|
| 1138 | + $cursor->closeCursor(); |
|
| 1139 | + |
|
| 1140 | + if ($currentAccess === true) { |
|
| 1141 | + $users = array_map([$this, 'filterSharesOfUser'], $users); |
|
| 1142 | + $users = array_filter($users); |
|
| 1143 | + } else { |
|
| 1144 | + $users = array_keys($users); |
|
| 1145 | + } |
|
| 1146 | + |
|
| 1147 | + return ['users' => $users, 'public' => $link]; |
|
| 1148 | + } |
|
| 1149 | + |
|
| 1150 | + /** |
|
| 1151 | + * For each user the path with the fewest slashes is returned |
|
| 1152 | + * @param array $shares |
|
| 1153 | + * @return array |
|
| 1154 | + */ |
|
| 1155 | + protected function filterSharesOfUser(array $shares) { |
|
| 1156 | + // Group shares when the user has a share exception |
|
| 1157 | + foreach ($shares as $id => $share) { |
|
| 1158 | + $type = (int) $share['share_type']; |
|
| 1159 | + $permissions = (int) $share['permissions']; |
|
| 1160 | + |
|
| 1161 | + if ($type === self::SHARE_TYPE_USERGROUP) { |
|
| 1162 | + unset($shares[$share['parent']]); |
|
| 1163 | + |
|
| 1164 | + if ($permissions === 0) { |
|
| 1165 | + unset($shares[$id]); |
|
| 1166 | + } |
|
| 1167 | + } |
|
| 1168 | + } |
|
| 1169 | + |
|
| 1170 | + $best = []; |
|
| 1171 | + $bestDepth = 0; |
|
| 1172 | + foreach ($shares as $id => $share) { |
|
| 1173 | + $depth = substr_count($share['file_target'], '/'); |
|
| 1174 | + if (empty($best) || $depth < $bestDepth) { |
|
| 1175 | + $bestDepth = $depth; |
|
| 1176 | + $best = [ |
|
| 1177 | + 'node_id' => $share['file_source'], |
|
| 1178 | + 'node_path' => $share['file_target'], |
|
| 1179 | + ]; |
|
| 1180 | + } |
|
| 1181 | + } |
|
| 1182 | + |
|
| 1183 | + return $best; |
|
| 1184 | + } |
|
| 1185 | 1185 | } |
@@ -287,7 +287,7 @@ discard block |
||
| 287 | 287 | ->orderBy('id'); |
| 288 | 288 | |
| 289 | 289 | $cursor = $qb->execute(); |
| 290 | - while($data = $cursor->fetch()) { |
|
| 290 | + while ($data = $cursor->fetch()) { |
|
| 291 | 291 | $children[] = $this->createShare($data); |
| 292 | 292 | } |
| 293 | 293 | $cursor->closeCursor(); |
@@ -332,7 +332,7 @@ discard block |
||
| 332 | 332 | $user = $this->userManager->get($recipient); |
| 333 | 333 | |
| 334 | 334 | if (is_null($group)) { |
| 335 | - throw new ProviderException('Group "' . $share->getSharedWith() . '" does not exist'); |
|
| 335 | + throw new ProviderException('Group "'.$share->getSharedWith().'" does not exist'); |
|
| 336 | 336 | } |
| 337 | 337 | |
| 338 | 338 | if (!$group->inGroup($user)) { |
@@ -492,7 +492,7 @@ discard block |
||
| 492 | 492 | ); |
| 493 | 493 | } |
| 494 | 494 | |
| 495 | - $qb->innerJoin('s', 'filecache' ,'f', $qb->expr()->eq('s.file_source', 'f.fileid')); |
|
| 495 | + $qb->innerJoin('s', 'filecache', 'f', $qb->expr()->eq('s.file_source', 'f.fileid')); |
|
| 496 | 496 | $qb->andWhere($qb->expr()->eq('f.parent', $qb->createNamedParameter($node->getId()))); |
| 497 | 497 | |
| 498 | 498 | $qb->orderBy('id'); |
@@ -548,7 +548,7 @@ discard block |
||
| 548 | 548 | |
| 549 | 549 | $cursor = $qb->execute(); |
| 550 | 550 | $shares = []; |
| 551 | - while($data = $cursor->fetch()) { |
|
| 551 | + while ($data = $cursor->fetch()) { |
|
| 552 | 552 | $shares[] = $this->createShare($data); |
| 553 | 553 | } |
| 554 | 554 | $cursor->closeCursor(); |
@@ -627,7 +627,7 @@ discard block |
||
| 627 | 627 | ->execute(); |
| 628 | 628 | |
| 629 | 629 | $shares = []; |
| 630 | - while($data = $cursor->fetch()) { |
|
| 630 | + while ($data = $cursor->fetch()) { |
|
| 631 | 631 | $shares[] = $this->createShare($data); |
| 632 | 632 | } |
| 633 | 633 | $cursor->closeCursor(); |
@@ -698,7 +698,7 @@ discard block |
||
| 698 | 698 | |
| 699 | 699 | $cursor = $qb->execute(); |
| 700 | 700 | |
| 701 | - while($data = $cursor->fetch()) { |
|
| 701 | + while ($data = $cursor->fetch()) { |
|
| 702 | 702 | if ($this->isAccessibleResult($data)) { |
| 703 | 703 | $shares[] = $this->createShare($data); |
| 704 | 704 | } |
@@ -713,7 +713,7 @@ discard block |
||
| 713 | 713 | $shares2 = []; |
| 714 | 714 | |
| 715 | 715 | $start = 0; |
| 716 | - while(true) { |
|
| 716 | + while (true) { |
|
| 717 | 717 | $groups = array_slice($allGroups, $start, 100); |
| 718 | 718 | $start += 100; |
| 719 | 719 | |
@@ -758,7 +758,7 @@ discard block |
||
| 758 | 758 | )); |
| 759 | 759 | |
| 760 | 760 | $cursor = $qb->execute(); |
| 761 | - while($data = $cursor->fetch()) { |
|
| 761 | + while ($data = $cursor->fetch()) { |
|
| 762 | 762 | if ($offset > 0) { |
| 763 | 763 | $offset--; |
| 764 | 764 | continue; |
@@ -827,14 +827,14 @@ discard block |
||
| 827 | 827 | */ |
| 828 | 828 | private function createShare($data) { |
| 829 | 829 | $share = new Share($this->rootFolder, $this->userManager); |
| 830 | - $share->setId((int)$data['id']) |
|
| 831 | - ->setShareType((int)$data['share_type']) |
|
| 832 | - ->setPermissions((int)$data['permissions']) |
|
| 830 | + $share->setId((int) $data['id']) |
|
| 831 | + ->setShareType((int) $data['share_type']) |
|
| 832 | + ->setPermissions((int) $data['permissions']) |
|
| 833 | 833 | ->setTarget($data['file_target']) |
| 834 | - ->setMailSend((bool)$data['mail_send']); |
|
| 834 | + ->setMailSend((bool) $data['mail_send']); |
|
| 835 | 835 | |
| 836 | 836 | $shareTime = new \DateTime(); |
| 837 | - $shareTime->setTimestamp((int)$data['stime']); |
|
| 837 | + $shareTime->setTimestamp((int) $data['stime']); |
|
| 838 | 838 | $share->setShareTime($shareTime); |
| 839 | 839 | |
| 840 | 840 | if ($share->getShareType() === \OCP\Share::SHARE_TYPE_USER) { |
@@ -849,7 +849,7 @@ discard block |
||
| 849 | 849 | $share->setSharedBy($data['uid_initiator']); |
| 850 | 850 | $share->setShareOwner($data['uid_owner']); |
| 851 | 851 | |
| 852 | - $share->setNodeId((int)$data['file_source']); |
|
| 852 | + $share->setNodeId((int) $data['file_source']); |
|
| 853 | 853 | $share->setNodeType($data['item_type']); |
| 854 | 854 | |
| 855 | 855 | if ($data['expiration'] !== null) { |
@@ -879,7 +879,7 @@ discard block |
||
| 879 | 879 | $result = []; |
| 880 | 880 | |
| 881 | 881 | $start = 0; |
| 882 | - while(true) { |
|
| 882 | + while (true) { |
|
| 883 | 883 | /** @var Share[] $shareSlice */ |
| 884 | 884 | $shareSlice = array_slice($shares, $start, 100); |
| 885 | 885 | $start += 100; |
@@ -894,7 +894,7 @@ discard block |
||
| 894 | 894 | $shareMap = []; |
| 895 | 895 | |
| 896 | 896 | foreach ($shareSlice as $share) { |
| 897 | - $ids[] = (int)$share->getId(); |
|
| 897 | + $ids[] = (int) $share->getId(); |
|
| 898 | 898 | $shareMap[$share->getId()] = $share; |
| 899 | 899 | } |
| 900 | 900 | |
@@ -911,8 +911,8 @@ discard block |
||
| 911 | 911 | |
| 912 | 912 | $stmt = $query->execute(); |
| 913 | 913 | |
| 914 | - while($data = $stmt->fetch()) { |
|
| 915 | - $shareMap[$data['parent']]->setPermissions((int)$data['permissions']); |
|
| 914 | + while ($data = $stmt->fetch()) { |
|
| 915 | + $shareMap[$data['parent']]->setPermissions((int) $data['permissions']); |
|
| 916 | 916 | $shareMap[$data['parent']]->setTarget($data['file_target']); |
| 917 | 917 | } |
| 918 | 918 | |
@@ -1009,8 +1009,8 @@ discard block |
||
| 1009 | 1009 | |
| 1010 | 1010 | $cursor = $qb->execute(); |
| 1011 | 1011 | $ids = []; |
| 1012 | - while($row = $cursor->fetch()) { |
|
| 1013 | - $ids[] = (int)$row['id']; |
|
| 1012 | + while ($row = $cursor->fetch()) { |
|
| 1013 | + $ids[] = (int) $row['id']; |
|
| 1014 | 1014 | } |
| 1015 | 1015 | $cursor->closeCursor(); |
| 1016 | 1016 | |
@@ -1052,8 +1052,8 @@ discard block |
||
| 1052 | 1052 | |
| 1053 | 1053 | $cursor = $qb->execute(); |
| 1054 | 1054 | $ids = []; |
| 1055 | - while($row = $cursor->fetch()) { |
|
| 1056 | - $ids[] = (int)$row['id']; |
|
| 1055 | + while ($row = $cursor->fetch()) { |
|
| 1056 | + $ids[] = (int) $row['id']; |
|
| 1057 | 1057 | } |
| 1058 | 1058 | $cursor->closeCursor(); |
| 1059 | 1059 | |
@@ -1107,8 +1107,8 @@ discard block |
||
| 1107 | 1107 | |
| 1108 | 1108 | $users = []; |
| 1109 | 1109 | $link = false; |
| 1110 | - while($row = $cursor->fetch()) { |
|
| 1111 | - $type = (int)$row['share_type']; |
|
| 1110 | + while ($row = $cursor->fetch()) { |
|
| 1111 | + $type = (int) $row['share_type']; |
|
| 1112 | 1112 | if ($type === \OCP\Share::SHARE_TYPE_USER) { |
| 1113 | 1113 | $uid = $row['share_with']; |
| 1114 | 1114 | $users[$uid] = isset($users[$uid]) ? $users[$uid] : []; |
@@ -61,7 +61,7 @@ |
||
| 61 | 61 | * The deserialize method is called during xml parsing. |
| 62 | 62 | * |
| 63 | 63 | * @param Reader $reader |
| 64 | - * @return mixed |
|
| 64 | + * @return null|ShareTypeList |
|
| 65 | 65 | */ |
| 66 | 66 | static function xmlDeserialize(Reader $reader) { |
| 67 | 67 | $shareTypes = []; |
@@ -32,61 +32,61 @@ |
||
| 32 | 32 | * This property contains multiple "share-type" elements, each containing a share type. |
| 33 | 33 | */ |
| 34 | 34 | class ShareTypeList implements Element { |
| 35 | - const NS_OWNCLOUD = 'http://owncloud.org/ns'; |
|
| 35 | + const NS_OWNCLOUD = 'http://owncloud.org/ns'; |
|
| 36 | 36 | |
| 37 | - /** |
|
| 38 | - * Share types |
|
| 39 | - * |
|
| 40 | - * @var int[] |
|
| 41 | - */ |
|
| 42 | - private $shareTypes; |
|
| 37 | + /** |
|
| 38 | + * Share types |
|
| 39 | + * |
|
| 40 | + * @var int[] |
|
| 41 | + */ |
|
| 42 | + private $shareTypes; |
|
| 43 | 43 | |
| 44 | - /** |
|
| 45 | - * @param int[] $shareTypes |
|
| 46 | - */ |
|
| 47 | - public function __construct($shareTypes) { |
|
| 48 | - $this->shareTypes = $shareTypes; |
|
| 49 | - } |
|
| 44 | + /** |
|
| 45 | + * @param int[] $shareTypes |
|
| 46 | + */ |
|
| 47 | + public function __construct($shareTypes) { |
|
| 48 | + $this->shareTypes = $shareTypes; |
|
| 49 | + } |
|
| 50 | 50 | |
| 51 | - /** |
|
| 52 | - * Returns the share types |
|
| 53 | - * |
|
| 54 | - * @return int[] |
|
| 55 | - */ |
|
| 56 | - public function getShareTypes() { |
|
| 57 | - return $this->shareTypes; |
|
| 58 | - } |
|
| 51 | + /** |
|
| 52 | + * Returns the share types |
|
| 53 | + * |
|
| 54 | + * @return int[] |
|
| 55 | + */ |
|
| 56 | + public function getShareTypes() { |
|
| 57 | + return $this->shareTypes; |
|
| 58 | + } |
|
| 59 | 59 | |
| 60 | - /** |
|
| 61 | - * The deserialize method is called during xml parsing. |
|
| 62 | - * |
|
| 63 | - * @param Reader $reader |
|
| 64 | - * @return mixed |
|
| 65 | - */ |
|
| 66 | - static function xmlDeserialize(Reader $reader) { |
|
| 67 | - $shareTypes = []; |
|
| 60 | + /** |
|
| 61 | + * The deserialize method is called during xml parsing. |
|
| 62 | + * |
|
| 63 | + * @param Reader $reader |
|
| 64 | + * @return mixed |
|
| 65 | + */ |
|
| 66 | + static function xmlDeserialize(Reader $reader) { |
|
| 67 | + $shareTypes = []; |
|
| 68 | 68 | |
| 69 | - $tree = $reader->parseInnerTree(); |
|
| 70 | - if ($tree === null) { |
|
| 71 | - return null; |
|
| 72 | - } |
|
| 73 | - foreach ($tree as $elem) { |
|
| 74 | - if ($elem['name'] === '{' . self::NS_OWNCLOUD . '}share-type') { |
|
| 75 | - $shareTypes[] = (int)$elem['value']; |
|
| 76 | - } |
|
| 77 | - } |
|
| 78 | - return new self($shareTypes); |
|
| 79 | - } |
|
| 69 | + $tree = $reader->parseInnerTree(); |
|
| 70 | + if ($tree === null) { |
|
| 71 | + return null; |
|
| 72 | + } |
|
| 73 | + foreach ($tree as $elem) { |
|
| 74 | + if ($elem['name'] === '{' . self::NS_OWNCLOUD . '}share-type') { |
|
| 75 | + $shareTypes[] = (int)$elem['value']; |
|
| 76 | + } |
|
| 77 | + } |
|
| 78 | + return new self($shareTypes); |
|
| 79 | + } |
|
| 80 | 80 | |
| 81 | - /** |
|
| 82 | - * The xmlSerialize metod is called during xml writing. |
|
| 83 | - * |
|
| 84 | - * @param Writer $writer |
|
| 85 | - * @return void |
|
| 86 | - */ |
|
| 87 | - function xmlSerialize(Writer $writer) { |
|
| 88 | - foreach ($this->shareTypes as $shareType) { |
|
| 89 | - $writer->writeElement('{' . self::NS_OWNCLOUD . '}share-type', $shareType); |
|
| 90 | - } |
|
| 91 | - } |
|
| 81 | + /** |
|
| 82 | + * The xmlSerialize metod is called during xml writing. |
|
| 83 | + * |
|
| 84 | + * @param Writer $writer |
|
| 85 | + * @return void |
|
| 86 | + */ |
|
| 87 | + function xmlSerialize(Writer $writer) { |
|
| 88 | + foreach ($this->shareTypes as $shareType) { |
|
| 89 | + $writer->writeElement('{' . self::NS_OWNCLOUD . '}share-type', $shareType); |
|
| 90 | + } |
|
| 91 | + } |
|
| 92 | 92 | } |
@@ -71,8 +71,8 @@ discard block |
||
| 71 | 71 | return null; |
| 72 | 72 | } |
| 73 | 73 | foreach ($tree as $elem) { |
| 74 | - if ($elem['name'] === '{' . self::NS_OWNCLOUD . '}share-type') { |
|
| 75 | - $shareTypes[] = (int)$elem['value']; |
|
| 74 | + if ($elem['name'] === '{'.self::NS_OWNCLOUD.'}share-type') { |
|
| 75 | + $shareTypes[] = (int) $elem['value']; |
|
| 76 | 76 | } |
| 77 | 77 | } |
| 78 | 78 | return new self($shareTypes); |
@@ -86,7 +86,7 @@ discard block |
||
| 86 | 86 | */ |
| 87 | 87 | function xmlSerialize(Writer $writer) { |
| 88 | 88 | foreach ($this->shareTypes as $shareType) { |
| 89 | - $writer->writeElement('{' . self::NS_OWNCLOUD . '}share-type', $shareType); |
|
| 89 | + $writer->writeElement('{'.self::NS_OWNCLOUD.'}share-type', $shareType); |
|
| 90 | 90 | } |
| 91 | 91 | } |
| 92 | 92 | } |
@@ -80,7 +80,7 @@ |
||
| 80 | 80 | * the next element. |
| 81 | 81 | * |
| 82 | 82 | * @param Reader $reader |
| 83 | - * @return mixed |
|
| 83 | + * @return null|TagList |
|
| 84 | 84 | */ |
| 85 | 85 | static function xmlDeserialize(Reader $reader) { |
| 86 | 86 | $tags = []; |
@@ -34,92 +34,92 @@ |
||
| 34 | 34 | * This property contains multiple "tag" elements, each containing a tag name. |
| 35 | 35 | */ |
| 36 | 36 | class TagList implements Element { |
| 37 | - const NS_OWNCLOUD = 'http://owncloud.org/ns'; |
|
| 37 | + const NS_OWNCLOUD = 'http://owncloud.org/ns'; |
|
| 38 | 38 | |
| 39 | - /** |
|
| 40 | - * tags |
|
| 41 | - * |
|
| 42 | - * @var array |
|
| 43 | - */ |
|
| 44 | - private $tags; |
|
| 39 | + /** |
|
| 40 | + * tags |
|
| 41 | + * |
|
| 42 | + * @var array |
|
| 43 | + */ |
|
| 44 | + private $tags; |
|
| 45 | 45 | |
| 46 | - /** |
|
| 47 | - * @param array $tags |
|
| 48 | - */ |
|
| 49 | - public function __construct(array $tags) { |
|
| 50 | - $this->tags = $tags; |
|
| 51 | - } |
|
| 46 | + /** |
|
| 47 | + * @param array $tags |
|
| 48 | + */ |
|
| 49 | + public function __construct(array $tags) { |
|
| 50 | + $this->tags = $tags; |
|
| 51 | + } |
|
| 52 | 52 | |
| 53 | - /** |
|
| 54 | - * Returns the tags |
|
| 55 | - * |
|
| 56 | - * @return array |
|
| 57 | - */ |
|
| 58 | - public function getTags() { |
|
| 53 | + /** |
|
| 54 | + * Returns the tags |
|
| 55 | + * |
|
| 56 | + * @return array |
|
| 57 | + */ |
|
| 58 | + public function getTags() { |
|
| 59 | 59 | |
| 60 | - return $this->tags; |
|
| 60 | + return $this->tags; |
|
| 61 | 61 | |
| 62 | - } |
|
| 62 | + } |
|
| 63 | 63 | |
| 64 | - /** |
|
| 65 | - * The deserialize method is called during xml parsing. |
|
| 66 | - * |
|
| 67 | - * This method is called statictly, this is because in theory this method |
|
| 68 | - * may be used as a type of constructor, or factory method. |
|
| 69 | - * |
|
| 70 | - * Often you want to return an instance of the current class, but you are |
|
| 71 | - * free to return other data as well. |
|
| 72 | - * |
|
| 73 | - * You are responsible for advancing the reader to the next element. Not |
|
| 74 | - * doing anything will result in a never-ending loop. |
|
| 75 | - * |
|
| 76 | - * If you just want to skip parsing for this element altogether, you can |
|
| 77 | - * just call $reader->next(); |
|
| 78 | - * |
|
| 79 | - * $reader->parseInnerTree() will parse the entire sub-tree, and advance to |
|
| 80 | - * the next element. |
|
| 81 | - * |
|
| 82 | - * @param Reader $reader |
|
| 83 | - * @return mixed |
|
| 84 | - */ |
|
| 85 | - static function xmlDeserialize(Reader $reader) { |
|
| 86 | - $tags = []; |
|
| 64 | + /** |
|
| 65 | + * The deserialize method is called during xml parsing. |
|
| 66 | + * |
|
| 67 | + * This method is called statictly, this is because in theory this method |
|
| 68 | + * may be used as a type of constructor, or factory method. |
|
| 69 | + * |
|
| 70 | + * Often you want to return an instance of the current class, but you are |
|
| 71 | + * free to return other data as well. |
|
| 72 | + * |
|
| 73 | + * You are responsible for advancing the reader to the next element. Not |
|
| 74 | + * doing anything will result in a never-ending loop. |
|
| 75 | + * |
|
| 76 | + * If you just want to skip parsing for this element altogether, you can |
|
| 77 | + * just call $reader->next(); |
|
| 78 | + * |
|
| 79 | + * $reader->parseInnerTree() will parse the entire sub-tree, and advance to |
|
| 80 | + * the next element. |
|
| 81 | + * |
|
| 82 | + * @param Reader $reader |
|
| 83 | + * @return mixed |
|
| 84 | + */ |
|
| 85 | + static function xmlDeserialize(Reader $reader) { |
|
| 86 | + $tags = []; |
|
| 87 | 87 | |
| 88 | - $tree = $reader->parseInnerTree(); |
|
| 89 | - if ($tree === null) { |
|
| 90 | - return null; |
|
| 91 | - } |
|
| 92 | - foreach ($tree as $elem) { |
|
| 93 | - if ($elem['name'] === '{' . self::NS_OWNCLOUD . '}tag') { |
|
| 94 | - $tags[] = $elem['value']; |
|
| 95 | - } |
|
| 96 | - } |
|
| 97 | - return new self($tags); |
|
| 98 | - } |
|
| 88 | + $tree = $reader->parseInnerTree(); |
|
| 89 | + if ($tree === null) { |
|
| 90 | + return null; |
|
| 91 | + } |
|
| 92 | + foreach ($tree as $elem) { |
|
| 93 | + if ($elem['name'] === '{' . self::NS_OWNCLOUD . '}tag') { |
|
| 94 | + $tags[] = $elem['value']; |
|
| 95 | + } |
|
| 96 | + } |
|
| 97 | + return new self($tags); |
|
| 98 | + } |
|
| 99 | 99 | |
| 100 | - /** |
|
| 101 | - * The xmlSerialize metod is called during xml writing. |
|
| 102 | - * |
|
| 103 | - * Use the $writer argument to write its own xml serialization. |
|
| 104 | - * |
|
| 105 | - * An important note: do _not_ create a parent element. Any element |
|
| 106 | - * implementing XmlSerializble should only ever write what's considered |
|
| 107 | - * its 'inner xml'. |
|
| 108 | - * |
|
| 109 | - * The parent of the current element is responsible for writing a |
|
| 110 | - * containing element. |
|
| 111 | - * |
|
| 112 | - * This allows serializers to be re-used for different element names. |
|
| 113 | - * |
|
| 114 | - * If you are opening new elements, you must also close them again. |
|
| 115 | - * |
|
| 116 | - * @param Writer $writer |
|
| 117 | - * @return void |
|
| 118 | - */ |
|
| 119 | - function xmlSerialize(Writer $writer) { |
|
| 100 | + /** |
|
| 101 | + * The xmlSerialize metod is called during xml writing. |
|
| 102 | + * |
|
| 103 | + * Use the $writer argument to write its own xml serialization. |
|
| 104 | + * |
|
| 105 | + * An important note: do _not_ create a parent element. Any element |
|
| 106 | + * implementing XmlSerializble should only ever write what's considered |
|
| 107 | + * its 'inner xml'. |
|
| 108 | + * |
|
| 109 | + * The parent of the current element is responsible for writing a |
|
| 110 | + * containing element. |
|
| 111 | + * |
|
| 112 | + * This allows serializers to be re-used for different element names. |
|
| 113 | + * |
|
| 114 | + * If you are opening new elements, you must also close them again. |
|
| 115 | + * |
|
| 116 | + * @param Writer $writer |
|
| 117 | + * @return void |
|
| 118 | + */ |
|
| 119 | + function xmlSerialize(Writer $writer) { |
|
| 120 | 120 | |
| 121 | - foreach ($this->tags as $tag) { |
|
| 122 | - $writer->writeElement('{' . self::NS_OWNCLOUD . '}tag', $tag); |
|
| 123 | - } |
|
| 124 | - } |
|
| 121 | + foreach ($this->tags as $tag) { |
|
| 122 | + $writer->writeElement('{' . self::NS_OWNCLOUD . '}tag', $tag); |
|
| 123 | + } |
|
| 124 | + } |
|
| 125 | 125 | } |
@@ -90,7 +90,7 @@ discard block |
||
| 90 | 90 | return null; |
| 91 | 91 | } |
| 92 | 92 | foreach ($tree as $elem) { |
| 93 | - if ($elem['name'] === '{' . self::NS_OWNCLOUD . '}tag') { |
|
| 93 | + if ($elem['name'] === '{'.self::NS_OWNCLOUD.'}tag') { |
|
| 94 | 94 | $tags[] = $elem['value']; |
| 95 | 95 | } |
| 96 | 96 | } |
@@ -119,7 +119,7 @@ discard block |
||
| 119 | 119 | function xmlSerialize(Writer $writer) { |
| 120 | 120 | |
| 121 | 121 | foreach ($this->tags as $tag) { |
| 122 | - $writer->writeElement('{' . self::NS_OWNCLOUD . '}tag', $tag); |
|
| 122 | + $writer->writeElement('{'.self::NS_OWNCLOUD.'}tag', $tag); |
|
| 123 | 123 | } |
| 124 | 124 | } |
| 125 | 125 | } |
@@ -318,6 +318,11 @@ |
||
| 318 | 318 | */ |
| 319 | 319 | // FIXME This method is only public, until OC_L10N does not need it anymore, |
| 320 | 320 | // FIXME This is also the reason, why it is not in the public interface |
| 321 | + |
|
| 322 | + /** |
|
| 323 | + * @param string $app |
|
| 324 | + * @param string $lang |
|
| 325 | + */ |
|
| 321 | 326 | public function getL10nFilesForApp($app, $lang) { |
| 322 | 327 | $languageFiles = []; |
| 323 | 328 | |
@@ -131,9 +131,9 @@ discard block |
||
| 131 | 131 | * |
| 132 | 132 | * @link https://github.com/owncloud/core/issues/21955 |
| 133 | 133 | */ |
| 134 | - if($this->config->getSystemValue('installed', false)) { |
|
| 135 | - $userId = !is_null($this->userSession->getUser()) ? $this->userSession->getUser()->getUID() : null; |
|
| 136 | - if(!is_null($userId)) { |
|
| 134 | + if ($this->config->getSystemValue('installed', false)) { |
|
| 135 | + $userId = !is_null($this->userSession->getUser()) ? $this->userSession->getUser()->getUID() : null; |
|
| 136 | + if (!is_null($userId)) { |
|
| 137 | 137 | $userLang = $this->config->getUserValue($userId, 'core', 'lang', null); |
| 138 | 138 | } else { |
| 139 | 139 | $userLang = null; |
@@ -202,7 +202,7 @@ discard block |
||
| 202 | 202 | // merge with translations from theme |
| 203 | 203 | $theme = $this->config->getSystemValue('theme'); |
| 204 | 204 | if (!empty($theme)) { |
| 205 | - $themeDir = $this->serverRoot . '/themes/' . $theme . substr($dir, strlen($this->serverRoot)); |
|
| 205 | + $themeDir = $this->serverRoot.'/themes/'.$theme.substr($dir, strlen($this->serverRoot)); |
|
| 206 | 206 | |
| 207 | 207 | if (is_dir($themeDir)) { |
| 208 | 208 | $files = scandir($themeDir); |
@@ -297,7 +297,7 @@ discard block |
||
| 297 | 297 | */ |
| 298 | 298 | private function isSubDirectory($sub, $parent) { |
| 299 | 299 | // Check whether $sub contains no ".." |
| 300 | - if(strpos($sub, '..') !== false) { |
|
| 300 | + if (strpos($sub, '..') !== false) { |
|
| 301 | 301 | return false; |
| 302 | 302 | } |
| 303 | 303 | |
@@ -322,12 +322,12 @@ discard block |
||
| 322 | 322 | $languageFiles = []; |
| 323 | 323 | |
| 324 | 324 | $i18nDir = $this->findL10nDir($app); |
| 325 | - $transFile = strip_tags($i18nDir) . strip_tags($lang) . '.json'; |
|
| 325 | + $transFile = strip_tags($i18nDir).strip_tags($lang).'.json'; |
|
| 326 | 326 | |
| 327 | - if (($this->isSubDirectory($transFile, $this->serverRoot . '/core/l10n/') |
|
| 328 | - || $this->isSubDirectory($transFile, $this->serverRoot . '/lib/l10n/') |
|
| 329 | - || $this->isSubDirectory($transFile, $this->serverRoot . '/settings/l10n/') |
|
| 330 | - || $this->isSubDirectory($transFile, \OC_App::getAppPath($app) . '/l10n/') |
|
| 327 | + if (($this->isSubDirectory($transFile, $this->serverRoot.'/core/l10n/') |
|
| 328 | + || $this->isSubDirectory($transFile, $this->serverRoot.'/lib/l10n/') |
|
| 329 | + || $this->isSubDirectory($transFile, $this->serverRoot.'/settings/l10n/') |
|
| 330 | + || $this->isSubDirectory($transFile, \OC_App::getAppPath($app).'/l10n/') |
|
| 331 | 331 | ) |
| 332 | 332 | && file_exists($transFile)) { |
| 333 | 333 | // load the translations file |
@@ -337,7 +337,7 @@ discard block |
||
| 337 | 337 | // merge with translations from theme |
| 338 | 338 | $theme = $this->config->getSystemValue('theme'); |
| 339 | 339 | if (!empty($theme)) { |
| 340 | - $transFile = $this->serverRoot . '/themes/' . $theme . substr($transFile, strlen($this->serverRoot)); |
|
| 340 | + $transFile = $this->serverRoot.'/themes/'.$theme.substr($transFile, strlen($this->serverRoot)); |
|
| 341 | 341 | if (file_exists($transFile)) { |
| 342 | 342 | $languageFiles[] = $transFile; |
| 343 | 343 | } |
@@ -354,14 +354,14 @@ discard block |
||
| 354 | 354 | */ |
| 355 | 355 | protected function findL10nDir($app = null) { |
| 356 | 356 | if (in_array($app, ['core', 'lib', 'settings'])) { |
| 357 | - if (file_exists($this->serverRoot . '/' . $app . '/l10n/')) { |
|
| 358 | - return $this->serverRoot . '/' . $app . '/l10n/'; |
|
| 357 | + if (file_exists($this->serverRoot.'/'.$app.'/l10n/')) { |
|
| 358 | + return $this->serverRoot.'/'.$app.'/l10n/'; |
|
| 359 | 359 | } |
| 360 | 360 | } else if ($app && \OC_App::getAppPath($app) !== false) { |
| 361 | 361 | // Check if the app is in the app folder |
| 362 | - return \OC_App::getAppPath($app) . '/l10n/'; |
|
| 362 | + return \OC_App::getAppPath($app).'/l10n/'; |
|
| 363 | 363 | } |
| 364 | - return $this->serverRoot . '/core/l10n/'; |
|
| 364 | + return $this->serverRoot.'/core/l10n/'; |
|
| 365 | 365 | } |
| 366 | 366 | |
| 367 | 367 | |
@@ -378,15 +378,15 @@ discard block |
||
| 378 | 378 | return $this->pluralFunctions[$string]; |
| 379 | 379 | } |
| 380 | 380 | |
| 381 | - if (preg_match( '/^\s*nplurals\s*=\s*(\d+)\s*;\s*plural=(.*)$/u', $string, $matches)) { |
|
| 381 | + if (preg_match('/^\s*nplurals\s*=\s*(\d+)\s*;\s*plural=(.*)$/u', $string, $matches)) { |
|
| 382 | 382 | // sanitize |
| 383 | - $nplurals = preg_replace( '/[^0-9]/', '', $matches[1] ); |
|
| 384 | - $plural = preg_replace( '#[^n0-9:\(\)\?\|\&=!<>+*/\%-]#', '', $matches[2] ); |
|
| 383 | + $nplurals = preg_replace('/[^0-9]/', '', $matches[1]); |
|
| 384 | + $plural = preg_replace('#[^n0-9:\(\)\?\|\&=!<>+*/\%-]#', '', $matches[2]); |
|
| 385 | 385 | |
| 386 | 386 | $body = str_replace( |
| 387 | - array( 'plural', 'n', '$n$plurals', ), |
|
| 388 | - array( '$plural', '$n', '$nplurals', ), |
|
| 389 | - 'nplurals='. $nplurals . '; plural=' . $plural |
|
| 387 | + array('plural', 'n', '$n$plurals',), |
|
| 388 | + array('$plural', '$n', '$nplurals',), |
|
| 389 | + 'nplurals='.$nplurals.'; plural='.$plural |
|
| 390 | 390 | ); |
| 391 | 391 | |
| 392 | 392 | // add parents |
@@ -394,9 +394,9 @@ discard block |
||
| 394 | 394 | $body .= ';'; |
| 395 | 395 | $res = ''; |
| 396 | 396 | $p = 0; |
| 397 | - for($i = 0; $i < strlen($body); $i++) { |
|
| 397 | + for ($i = 0; $i < strlen($body); $i++) { |
|
| 398 | 398 | $ch = $body[$i]; |
| 399 | - switch ( $ch ) { |
|
| 399 | + switch ($ch) { |
|
| 400 | 400 | case '?': |
| 401 | 401 | $res .= ' ? ('; |
| 402 | 402 | $p++; |
@@ -405,7 +405,7 @@ discard block |
||
| 405 | 405 | $res .= ') : ('; |
| 406 | 406 | break; |
| 407 | 407 | case ';': |
| 408 | - $res .= str_repeat( ')', $p ) . ';'; |
|
| 408 | + $res .= str_repeat(')', $p).';'; |
|
| 409 | 409 | $p = 0; |
| 410 | 410 | break; |
| 411 | 411 | default: |
@@ -413,7 +413,7 @@ discard block |
||
| 413 | 413 | } |
| 414 | 414 | } |
| 415 | 415 | |
| 416 | - $body = $res . 'return ($plural>=$nplurals?$nplurals-1:$plural);'; |
|
| 416 | + $body = $res.'return ($plural>=$nplurals?$nplurals-1:$plural);'; |
|
| 417 | 417 | $function = create_function('$n', $body); |
| 418 | 418 | $this->pluralFunctions[$string] = $function; |
| 419 | 419 | return $function; |
@@ -40,379 +40,379 @@ |
||
| 40 | 40 | */ |
| 41 | 41 | class Factory implements IFactory { |
| 42 | 42 | |
| 43 | - /** @var string */ |
|
| 44 | - protected $requestLanguage = ''; |
|
| 45 | - |
|
| 46 | - /** |
|
| 47 | - * cached instances |
|
| 48 | - * @var array Structure: Lang => App => \OCP\IL10N |
|
| 49 | - */ |
|
| 50 | - protected $instances = []; |
|
| 51 | - |
|
| 52 | - /** |
|
| 53 | - * @var array Structure: App => string[] |
|
| 54 | - */ |
|
| 55 | - protected $availableLanguages = []; |
|
| 56 | - |
|
| 57 | - /** |
|
| 58 | - * @var array Structure: string => callable |
|
| 59 | - */ |
|
| 60 | - protected $pluralFunctions = []; |
|
| 61 | - |
|
| 62 | - /** @var IConfig */ |
|
| 63 | - protected $config; |
|
| 64 | - |
|
| 65 | - /** @var IRequest */ |
|
| 66 | - protected $request; |
|
| 67 | - |
|
| 68 | - /** @var IUserSession */ |
|
| 69 | - protected $userSession; |
|
| 70 | - |
|
| 71 | - /** @var string */ |
|
| 72 | - protected $serverRoot; |
|
| 73 | - |
|
| 74 | - /** |
|
| 75 | - * @param IConfig $config |
|
| 76 | - * @param IRequest $request |
|
| 77 | - * @param IUserSession $userSession |
|
| 78 | - * @param string $serverRoot |
|
| 79 | - */ |
|
| 80 | - public function __construct(IConfig $config, |
|
| 81 | - IRequest $request, |
|
| 82 | - IUserSession $userSession, |
|
| 83 | - $serverRoot) { |
|
| 84 | - $this->config = $config; |
|
| 85 | - $this->request = $request; |
|
| 86 | - $this->userSession = $userSession; |
|
| 87 | - $this->serverRoot = $serverRoot; |
|
| 88 | - } |
|
| 89 | - |
|
| 90 | - /** |
|
| 91 | - * Get a language instance |
|
| 92 | - * |
|
| 93 | - * @param string $app |
|
| 94 | - * @param string|null $lang |
|
| 95 | - * @return \OCP\IL10N |
|
| 96 | - */ |
|
| 97 | - public function get($app, $lang = null) { |
|
| 98 | - $app = \OC_App::cleanAppId($app); |
|
| 99 | - if ($lang !== null) { |
|
| 100 | - $lang = str_replace(array('\0', '/', '\\', '..'), '', (string) $lang); |
|
| 101 | - } |
|
| 102 | - |
|
| 103 | - $forceLang = $this->config->getSystemValue('force_language', false); |
|
| 104 | - if (is_string($forceLang)) { |
|
| 105 | - $lang = $forceLang; |
|
| 106 | - } |
|
| 107 | - |
|
| 108 | - if ($lang === null || !$this->languageExists($app, $lang)) { |
|
| 109 | - $lang = $this->findLanguage($app); |
|
| 110 | - } |
|
| 111 | - |
|
| 112 | - if (!isset($this->instances[$lang][$app])) { |
|
| 113 | - $this->instances[$lang][$app] = new L10N( |
|
| 114 | - $this, $app, $lang, |
|
| 115 | - $this->getL10nFilesForApp($app, $lang) |
|
| 116 | - ); |
|
| 117 | - } |
|
| 118 | - |
|
| 119 | - return $this->instances[$lang][$app]; |
|
| 120 | - } |
|
| 121 | - |
|
| 122 | - /** |
|
| 123 | - * Find the best language |
|
| 124 | - * |
|
| 125 | - * @param string|null $app App id or null for core |
|
| 126 | - * @return string language If nothing works it returns 'en' |
|
| 127 | - */ |
|
| 128 | - public function findLanguage($app = null) { |
|
| 129 | - if ($this->requestLanguage !== '' && $this->languageExists($app, $this->requestLanguage)) { |
|
| 130 | - return $this->requestLanguage; |
|
| 131 | - } |
|
| 132 | - |
|
| 133 | - /** |
|
| 134 | - * At this point Nextcloud might not yet be installed and thus the lookup |
|
| 135 | - * in the preferences table might fail. For this reason we need to check |
|
| 136 | - * whether the instance has already been installed |
|
| 137 | - * |
|
| 138 | - * @link https://github.com/owncloud/core/issues/21955 |
|
| 139 | - */ |
|
| 140 | - if($this->config->getSystemValue('installed', false)) { |
|
| 141 | - $userId = !is_null($this->userSession->getUser()) ? $this->userSession->getUser()->getUID() : null; |
|
| 142 | - if(!is_null($userId)) { |
|
| 143 | - $userLang = $this->config->getUserValue($userId, 'core', 'lang', null); |
|
| 144 | - } else { |
|
| 145 | - $userLang = null; |
|
| 146 | - } |
|
| 147 | - } else { |
|
| 148 | - $userId = null; |
|
| 149 | - $userLang = null; |
|
| 150 | - } |
|
| 151 | - |
|
| 152 | - if ($userLang) { |
|
| 153 | - $this->requestLanguage = $userLang; |
|
| 154 | - if ($this->languageExists($app, $userLang)) { |
|
| 155 | - return $userLang; |
|
| 156 | - } |
|
| 157 | - } |
|
| 158 | - |
|
| 159 | - try { |
|
| 160 | - // Try to get the language from the Request |
|
| 161 | - $lang = $this->getLanguageFromRequest($app); |
|
| 162 | - if ($userId !== null && $app === null && !$userLang) { |
|
| 163 | - $this->config->setUserValue($userId, 'core', 'lang', $lang); |
|
| 164 | - } |
|
| 165 | - return $lang; |
|
| 166 | - } catch (LanguageNotFoundException $e) { |
|
| 167 | - // Finding language from request failed fall back to default language |
|
| 168 | - $defaultLanguage = $this->config->getSystemValue('default_language', false); |
|
| 169 | - if ($defaultLanguage !== false && $this->languageExists($app, $defaultLanguage)) { |
|
| 170 | - return $defaultLanguage; |
|
| 171 | - } |
|
| 172 | - } |
|
| 173 | - |
|
| 174 | - // We could not find any language so fall back to english |
|
| 175 | - return 'en'; |
|
| 176 | - } |
|
| 177 | - |
|
| 178 | - /** |
|
| 179 | - * Find all available languages for an app |
|
| 180 | - * |
|
| 181 | - * @param string|null $app App id or null for core |
|
| 182 | - * @return array an array of available languages |
|
| 183 | - */ |
|
| 184 | - public function findAvailableLanguages($app = null) { |
|
| 185 | - $key = $app; |
|
| 186 | - if ($key === null) { |
|
| 187 | - $key = 'null'; |
|
| 188 | - } |
|
| 189 | - |
|
| 190 | - // also works with null as key |
|
| 191 | - if (!empty($this->availableLanguages[$key])) { |
|
| 192 | - return $this->availableLanguages[$key]; |
|
| 193 | - } |
|
| 194 | - |
|
| 195 | - $available = ['en']; //english is always available |
|
| 196 | - $dir = $this->findL10nDir($app); |
|
| 197 | - if (is_dir($dir)) { |
|
| 198 | - $files = scandir($dir); |
|
| 199 | - if ($files !== false) { |
|
| 200 | - foreach ($files as $file) { |
|
| 201 | - if (substr($file, -5) === '.json' && substr($file, 0, 4) !== 'l10n') { |
|
| 202 | - $available[] = substr($file, 0, -5); |
|
| 203 | - } |
|
| 204 | - } |
|
| 205 | - } |
|
| 206 | - } |
|
| 207 | - |
|
| 208 | - // merge with translations from theme |
|
| 209 | - $theme = $this->config->getSystemValue('theme'); |
|
| 210 | - if (!empty($theme)) { |
|
| 211 | - $themeDir = $this->serverRoot . '/themes/' . $theme . substr($dir, strlen($this->serverRoot)); |
|
| 212 | - |
|
| 213 | - if (is_dir($themeDir)) { |
|
| 214 | - $files = scandir($themeDir); |
|
| 215 | - if ($files !== false) { |
|
| 216 | - foreach ($files as $file) { |
|
| 217 | - if (substr($file, -5) === '.json' && substr($file, 0, 4) !== 'l10n') { |
|
| 218 | - $available[] = substr($file, 0, -5); |
|
| 219 | - } |
|
| 220 | - } |
|
| 221 | - } |
|
| 222 | - } |
|
| 223 | - } |
|
| 224 | - |
|
| 225 | - $this->availableLanguages[$key] = $available; |
|
| 226 | - return $available; |
|
| 227 | - } |
|
| 228 | - |
|
| 229 | - /** |
|
| 230 | - * @param string|null $app App id or null for core |
|
| 231 | - * @param string $lang |
|
| 232 | - * @return bool |
|
| 233 | - */ |
|
| 234 | - public function languageExists($app, $lang) { |
|
| 235 | - if ($lang === 'en') {//english is always available |
|
| 236 | - return true; |
|
| 237 | - } |
|
| 238 | - |
|
| 239 | - $languages = $this->findAvailableLanguages($app); |
|
| 240 | - return array_search($lang, $languages) !== false; |
|
| 241 | - } |
|
| 242 | - |
|
| 243 | - /** |
|
| 244 | - * @param string|null $app |
|
| 245 | - * @return string |
|
| 246 | - * @throws LanguageNotFoundException |
|
| 247 | - */ |
|
| 248 | - private function getLanguageFromRequest($app) { |
|
| 249 | - $header = $this->request->getHeader('ACCEPT_LANGUAGE'); |
|
| 250 | - if ($header) { |
|
| 251 | - $available = $this->findAvailableLanguages($app); |
|
| 252 | - |
|
| 253 | - // E.g. make sure that 'de' is before 'de_DE'. |
|
| 254 | - sort($available); |
|
| 255 | - |
|
| 256 | - $preferences = preg_split('/,\s*/', strtolower($header)); |
|
| 257 | - foreach ($preferences as $preference) { |
|
| 258 | - list($preferred_language) = explode(';', $preference); |
|
| 259 | - $preferred_language = str_replace('-', '_', $preferred_language); |
|
| 260 | - |
|
| 261 | - foreach ($available as $available_language) { |
|
| 262 | - if ($preferred_language === strtolower($available_language)) { |
|
| 263 | - return $available_language; |
|
| 264 | - } |
|
| 265 | - } |
|
| 266 | - |
|
| 267 | - // Fallback from de_De to de |
|
| 268 | - foreach ($available as $available_language) { |
|
| 269 | - if (substr($preferred_language, 0, 2) === $available_language) { |
|
| 270 | - return $available_language; |
|
| 271 | - } |
|
| 272 | - } |
|
| 273 | - } |
|
| 274 | - } |
|
| 275 | - |
|
| 276 | - throw new LanguageNotFoundException(); |
|
| 277 | - } |
|
| 278 | - |
|
| 279 | - /** |
|
| 280 | - * Checks if $sub is a subdirectory of $parent |
|
| 281 | - * |
|
| 282 | - * @param string $sub |
|
| 283 | - * @param string $parent |
|
| 284 | - * @return bool |
|
| 285 | - */ |
|
| 286 | - private function isSubDirectory($sub, $parent) { |
|
| 287 | - // Check whether $sub contains no ".." |
|
| 288 | - if(strpos($sub, '..') !== false) { |
|
| 289 | - return false; |
|
| 290 | - } |
|
| 291 | - |
|
| 292 | - // Check whether $sub is a subdirectory of $parent |
|
| 293 | - if (strpos($sub, $parent) === 0) { |
|
| 294 | - return true; |
|
| 295 | - } |
|
| 296 | - |
|
| 297 | - return false; |
|
| 298 | - } |
|
| 299 | - |
|
| 300 | - /** |
|
| 301 | - * Get a list of language files that should be loaded |
|
| 302 | - * |
|
| 303 | - * @param string $app |
|
| 304 | - * @param string $lang |
|
| 305 | - * @return string[] |
|
| 306 | - */ |
|
| 307 | - // FIXME This method is only public, until OC_L10N does not need it anymore, |
|
| 308 | - // FIXME This is also the reason, why it is not in the public interface |
|
| 309 | - public function getL10nFilesForApp($app, $lang) { |
|
| 310 | - $languageFiles = []; |
|
| 311 | - |
|
| 312 | - $i18nDir = $this->findL10nDir($app); |
|
| 313 | - $transFile = strip_tags($i18nDir) . strip_tags($lang) . '.json'; |
|
| 314 | - |
|
| 315 | - if (($this->isSubDirectory($transFile, $this->serverRoot . '/core/l10n/') |
|
| 316 | - || $this->isSubDirectory($transFile, $this->serverRoot . '/lib/l10n/') |
|
| 317 | - || $this->isSubDirectory($transFile, $this->serverRoot . '/settings/l10n/') |
|
| 318 | - || $this->isSubDirectory($transFile, \OC_App::getAppPath($app) . '/l10n/') |
|
| 319 | - ) |
|
| 320 | - && file_exists($transFile)) { |
|
| 321 | - // load the translations file |
|
| 322 | - $languageFiles[] = $transFile; |
|
| 323 | - } |
|
| 324 | - |
|
| 325 | - // merge with translations from theme |
|
| 326 | - $theme = $this->config->getSystemValue('theme'); |
|
| 327 | - if (!empty($theme)) { |
|
| 328 | - $transFile = $this->serverRoot . '/themes/' . $theme . substr($transFile, strlen($this->serverRoot)); |
|
| 329 | - if (file_exists($transFile)) { |
|
| 330 | - $languageFiles[] = $transFile; |
|
| 331 | - } |
|
| 332 | - } |
|
| 333 | - |
|
| 334 | - return $languageFiles; |
|
| 335 | - } |
|
| 336 | - |
|
| 337 | - /** |
|
| 338 | - * find the l10n directory |
|
| 339 | - * |
|
| 340 | - * @param string $app App id or empty string for core |
|
| 341 | - * @return string directory |
|
| 342 | - */ |
|
| 343 | - protected function findL10nDir($app = null) { |
|
| 344 | - if (in_array($app, ['core', 'lib', 'settings'])) { |
|
| 345 | - if (file_exists($this->serverRoot . '/' . $app . '/l10n/')) { |
|
| 346 | - return $this->serverRoot . '/' . $app . '/l10n/'; |
|
| 347 | - } |
|
| 348 | - } else if ($app && \OC_App::getAppPath($app) !== false) { |
|
| 349 | - // Check if the app is in the app folder |
|
| 350 | - return \OC_App::getAppPath($app) . '/l10n/'; |
|
| 351 | - } |
|
| 352 | - return $this->serverRoot . '/core/l10n/'; |
|
| 353 | - } |
|
| 354 | - |
|
| 355 | - |
|
| 356 | - /** |
|
| 357 | - * Creates a function from the plural string |
|
| 358 | - * |
|
| 359 | - * Parts of the code is copied from Habari: |
|
| 360 | - * https://github.com/habari/system/blob/master/classes/locale.php |
|
| 361 | - * @param string $string |
|
| 362 | - * @return string |
|
| 363 | - */ |
|
| 364 | - public function createPluralFunction($string) { |
|
| 365 | - if (isset($this->pluralFunctions[$string])) { |
|
| 366 | - return $this->pluralFunctions[$string]; |
|
| 367 | - } |
|
| 368 | - |
|
| 369 | - if (preg_match( '/^\s*nplurals\s*=\s*(\d+)\s*;\s*plural=(.*)$/u', $string, $matches)) { |
|
| 370 | - // sanitize |
|
| 371 | - $nplurals = preg_replace( '/[^0-9]/', '', $matches[1] ); |
|
| 372 | - $plural = preg_replace( '#[^n0-9:\(\)\?\|\&=!<>+*/\%-]#', '', $matches[2] ); |
|
| 373 | - |
|
| 374 | - $body = str_replace( |
|
| 375 | - array( 'plural', 'n', '$n$plurals', ), |
|
| 376 | - array( '$plural', '$n', '$nplurals', ), |
|
| 377 | - 'nplurals='. $nplurals . '; plural=' . $plural |
|
| 378 | - ); |
|
| 379 | - |
|
| 380 | - // add parents |
|
| 381 | - // important since PHP's ternary evaluates from left to right |
|
| 382 | - $body .= ';'; |
|
| 383 | - $res = ''; |
|
| 384 | - $p = 0; |
|
| 385 | - for($i = 0; $i < strlen($body); $i++) { |
|
| 386 | - $ch = $body[$i]; |
|
| 387 | - switch ( $ch ) { |
|
| 388 | - case '?': |
|
| 389 | - $res .= ' ? ('; |
|
| 390 | - $p++; |
|
| 391 | - break; |
|
| 392 | - case ':': |
|
| 393 | - $res .= ') : ('; |
|
| 394 | - break; |
|
| 395 | - case ';': |
|
| 396 | - $res .= str_repeat( ')', $p ) . ';'; |
|
| 397 | - $p = 0; |
|
| 398 | - break; |
|
| 399 | - default: |
|
| 400 | - $res .= $ch; |
|
| 401 | - } |
|
| 402 | - } |
|
| 403 | - |
|
| 404 | - $body = $res . 'return ($plural>=$nplurals?$nplurals-1:$plural);'; |
|
| 405 | - $function = create_function('$n', $body); |
|
| 406 | - $this->pluralFunctions[$string] = $function; |
|
| 407 | - return $function; |
|
| 408 | - } else { |
|
| 409 | - // default: one plural form for all cases but n==1 (english) |
|
| 410 | - $function = create_function( |
|
| 411 | - '$n', |
|
| 412 | - '$nplurals=2;$plural=($n==1?0:1);return ($plural>=$nplurals?$nplurals-1:$plural);' |
|
| 413 | - ); |
|
| 414 | - $this->pluralFunctions[$string] = $function; |
|
| 415 | - return $function; |
|
| 416 | - } |
|
| 417 | - } |
|
| 43 | + /** @var string */ |
|
| 44 | + protected $requestLanguage = ''; |
|
| 45 | + |
|
| 46 | + /** |
|
| 47 | + * cached instances |
|
| 48 | + * @var array Structure: Lang => App => \OCP\IL10N |
|
| 49 | + */ |
|
| 50 | + protected $instances = []; |
|
| 51 | + |
|
| 52 | + /** |
|
| 53 | + * @var array Structure: App => string[] |
|
| 54 | + */ |
|
| 55 | + protected $availableLanguages = []; |
|
| 56 | + |
|
| 57 | + /** |
|
| 58 | + * @var array Structure: string => callable |
|
| 59 | + */ |
|
| 60 | + protected $pluralFunctions = []; |
|
| 61 | + |
|
| 62 | + /** @var IConfig */ |
|
| 63 | + protected $config; |
|
| 64 | + |
|
| 65 | + /** @var IRequest */ |
|
| 66 | + protected $request; |
|
| 67 | + |
|
| 68 | + /** @var IUserSession */ |
|
| 69 | + protected $userSession; |
|
| 70 | + |
|
| 71 | + /** @var string */ |
|
| 72 | + protected $serverRoot; |
|
| 73 | + |
|
| 74 | + /** |
|
| 75 | + * @param IConfig $config |
|
| 76 | + * @param IRequest $request |
|
| 77 | + * @param IUserSession $userSession |
|
| 78 | + * @param string $serverRoot |
|
| 79 | + */ |
|
| 80 | + public function __construct(IConfig $config, |
|
| 81 | + IRequest $request, |
|
| 82 | + IUserSession $userSession, |
|
| 83 | + $serverRoot) { |
|
| 84 | + $this->config = $config; |
|
| 85 | + $this->request = $request; |
|
| 86 | + $this->userSession = $userSession; |
|
| 87 | + $this->serverRoot = $serverRoot; |
|
| 88 | + } |
|
| 89 | + |
|
| 90 | + /** |
|
| 91 | + * Get a language instance |
|
| 92 | + * |
|
| 93 | + * @param string $app |
|
| 94 | + * @param string|null $lang |
|
| 95 | + * @return \OCP\IL10N |
|
| 96 | + */ |
|
| 97 | + public function get($app, $lang = null) { |
|
| 98 | + $app = \OC_App::cleanAppId($app); |
|
| 99 | + if ($lang !== null) { |
|
| 100 | + $lang = str_replace(array('\0', '/', '\\', '..'), '', (string) $lang); |
|
| 101 | + } |
|
| 102 | + |
|
| 103 | + $forceLang = $this->config->getSystemValue('force_language', false); |
|
| 104 | + if (is_string($forceLang)) { |
|
| 105 | + $lang = $forceLang; |
|
| 106 | + } |
|
| 107 | + |
|
| 108 | + if ($lang === null || !$this->languageExists($app, $lang)) { |
|
| 109 | + $lang = $this->findLanguage($app); |
|
| 110 | + } |
|
| 111 | + |
|
| 112 | + if (!isset($this->instances[$lang][$app])) { |
|
| 113 | + $this->instances[$lang][$app] = new L10N( |
|
| 114 | + $this, $app, $lang, |
|
| 115 | + $this->getL10nFilesForApp($app, $lang) |
|
| 116 | + ); |
|
| 117 | + } |
|
| 118 | + |
|
| 119 | + return $this->instances[$lang][$app]; |
|
| 120 | + } |
|
| 121 | + |
|
| 122 | + /** |
|
| 123 | + * Find the best language |
|
| 124 | + * |
|
| 125 | + * @param string|null $app App id or null for core |
|
| 126 | + * @return string language If nothing works it returns 'en' |
|
| 127 | + */ |
|
| 128 | + public function findLanguage($app = null) { |
|
| 129 | + if ($this->requestLanguage !== '' && $this->languageExists($app, $this->requestLanguage)) { |
|
| 130 | + return $this->requestLanguage; |
|
| 131 | + } |
|
| 132 | + |
|
| 133 | + /** |
|
| 134 | + * At this point Nextcloud might not yet be installed and thus the lookup |
|
| 135 | + * in the preferences table might fail. For this reason we need to check |
|
| 136 | + * whether the instance has already been installed |
|
| 137 | + * |
|
| 138 | + * @link https://github.com/owncloud/core/issues/21955 |
|
| 139 | + */ |
|
| 140 | + if($this->config->getSystemValue('installed', false)) { |
|
| 141 | + $userId = !is_null($this->userSession->getUser()) ? $this->userSession->getUser()->getUID() : null; |
|
| 142 | + if(!is_null($userId)) { |
|
| 143 | + $userLang = $this->config->getUserValue($userId, 'core', 'lang', null); |
|
| 144 | + } else { |
|
| 145 | + $userLang = null; |
|
| 146 | + } |
|
| 147 | + } else { |
|
| 148 | + $userId = null; |
|
| 149 | + $userLang = null; |
|
| 150 | + } |
|
| 151 | + |
|
| 152 | + if ($userLang) { |
|
| 153 | + $this->requestLanguage = $userLang; |
|
| 154 | + if ($this->languageExists($app, $userLang)) { |
|
| 155 | + return $userLang; |
|
| 156 | + } |
|
| 157 | + } |
|
| 158 | + |
|
| 159 | + try { |
|
| 160 | + // Try to get the language from the Request |
|
| 161 | + $lang = $this->getLanguageFromRequest($app); |
|
| 162 | + if ($userId !== null && $app === null && !$userLang) { |
|
| 163 | + $this->config->setUserValue($userId, 'core', 'lang', $lang); |
|
| 164 | + } |
|
| 165 | + return $lang; |
|
| 166 | + } catch (LanguageNotFoundException $e) { |
|
| 167 | + // Finding language from request failed fall back to default language |
|
| 168 | + $defaultLanguage = $this->config->getSystemValue('default_language', false); |
|
| 169 | + if ($defaultLanguage !== false && $this->languageExists($app, $defaultLanguage)) { |
|
| 170 | + return $defaultLanguage; |
|
| 171 | + } |
|
| 172 | + } |
|
| 173 | + |
|
| 174 | + // We could not find any language so fall back to english |
|
| 175 | + return 'en'; |
|
| 176 | + } |
|
| 177 | + |
|
| 178 | + /** |
|
| 179 | + * Find all available languages for an app |
|
| 180 | + * |
|
| 181 | + * @param string|null $app App id or null for core |
|
| 182 | + * @return array an array of available languages |
|
| 183 | + */ |
|
| 184 | + public function findAvailableLanguages($app = null) { |
|
| 185 | + $key = $app; |
|
| 186 | + if ($key === null) { |
|
| 187 | + $key = 'null'; |
|
| 188 | + } |
|
| 189 | + |
|
| 190 | + // also works with null as key |
|
| 191 | + if (!empty($this->availableLanguages[$key])) { |
|
| 192 | + return $this->availableLanguages[$key]; |
|
| 193 | + } |
|
| 194 | + |
|
| 195 | + $available = ['en']; //english is always available |
|
| 196 | + $dir = $this->findL10nDir($app); |
|
| 197 | + if (is_dir($dir)) { |
|
| 198 | + $files = scandir($dir); |
|
| 199 | + if ($files !== false) { |
|
| 200 | + foreach ($files as $file) { |
|
| 201 | + if (substr($file, -5) === '.json' && substr($file, 0, 4) !== 'l10n') { |
|
| 202 | + $available[] = substr($file, 0, -5); |
|
| 203 | + } |
|
| 204 | + } |
|
| 205 | + } |
|
| 206 | + } |
|
| 207 | + |
|
| 208 | + // merge with translations from theme |
|
| 209 | + $theme = $this->config->getSystemValue('theme'); |
|
| 210 | + if (!empty($theme)) { |
|
| 211 | + $themeDir = $this->serverRoot . '/themes/' . $theme . substr($dir, strlen($this->serverRoot)); |
|
| 212 | + |
|
| 213 | + if (is_dir($themeDir)) { |
|
| 214 | + $files = scandir($themeDir); |
|
| 215 | + if ($files !== false) { |
|
| 216 | + foreach ($files as $file) { |
|
| 217 | + if (substr($file, -5) === '.json' && substr($file, 0, 4) !== 'l10n') { |
|
| 218 | + $available[] = substr($file, 0, -5); |
|
| 219 | + } |
|
| 220 | + } |
|
| 221 | + } |
|
| 222 | + } |
|
| 223 | + } |
|
| 224 | + |
|
| 225 | + $this->availableLanguages[$key] = $available; |
|
| 226 | + return $available; |
|
| 227 | + } |
|
| 228 | + |
|
| 229 | + /** |
|
| 230 | + * @param string|null $app App id or null for core |
|
| 231 | + * @param string $lang |
|
| 232 | + * @return bool |
|
| 233 | + */ |
|
| 234 | + public function languageExists($app, $lang) { |
|
| 235 | + if ($lang === 'en') {//english is always available |
|
| 236 | + return true; |
|
| 237 | + } |
|
| 238 | + |
|
| 239 | + $languages = $this->findAvailableLanguages($app); |
|
| 240 | + return array_search($lang, $languages) !== false; |
|
| 241 | + } |
|
| 242 | + |
|
| 243 | + /** |
|
| 244 | + * @param string|null $app |
|
| 245 | + * @return string |
|
| 246 | + * @throws LanguageNotFoundException |
|
| 247 | + */ |
|
| 248 | + private function getLanguageFromRequest($app) { |
|
| 249 | + $header = $this->request->getHeader('ACCEPT_LANGUAGE'); |
|
| 250 | + if ($header) { |
|
| 251 | + $available = $this->findAvailableLanguages($app); |
|
| 252 | + |
|
| 253 | + // E.g. make sure that 'de' is before 'de_DE'. |
|
| 254 | + sort($available); |
|
| 255 | + |
|
| 256 | + $preferences = preg_split('/,\s*/', strtolower($header)); |
|
| 257 | + foreach ($preferences as $preference) { |
|
| 258 | + list($preferred_language) = explode(';', $preference); |
|
| 259 | + $preferred_language = str_replace('-', '_', $preferred_language); |
|
| 260 | + |
|
| 261 | + foreach ($available as $available_language) { |
|
| 262 | + if ($preferred_language === strtolower($available_language)) { |
|
| 263 | + return $available_language; |
|
| 264 | + } |
|
| 265 | + } |
|
| 266 | + |
|
| 267 | + // Fallback from de_De to de |
|
| 268 | + foreach ($available as $available_language) { |
|
| 269 | + if (substr($preferred_language, 0, 2) === $available_language) { |
|
| 270 | + return $available_language; |
|
| 271 | + } |
|
| 272 | + } |
|
| 273 | + } |
|
| 274 | + } |
|
| 275 | + |
|
| 276 | + throw new LanguageNotFoundException(); |
|
| 277 | + } |
|
| 278 | + |
|
| 279 | + /** |
|
| 280 | + * Checks if $sub is a subdirectory of $parent |
|
| 281 | + * |
|
| 282 | + * @param string $sub |
|
| 283 | + * @param string $parent |
|
| 284 | + * @return bool |
|
| 285 | + */ |
|
| 286 | + private function isSubDirectory($sub, $parent) { |
|
| 287 | + // Check whether $sub contains no ".." |
|
| 288 | + if(strpos($sub, '..') !== false) { |
|
| 289 | + return false; |
|
| 290 | + } |
|
| 291 | + |
|
| 292 | + // Check whether $sub is a subdirectory of $parent |
|
| 293 | + if (strpos($sub, $parent) === 0) { |
|
| 294 | + return true; |
|
| 295 | + } |
|
| 296 | + |
|
| 297 | + return false; |
|
| 298 | + } |
|
| 299 | + |
|
| 300 | + /** |
|
| 301 | + * Get a list of language files that should be loaded |
|
| 302 | + * |
|
| 303 | + * @param string $app |
|
| 304 | + * @param string $lang |
|
| 305 | + * @return string[] |
|
| 306 | + */ |
|
| 307 | + // FIXME This method is only public, until OC_L10N does not need it anymore, |
|
| 308 | + // FIXME This is also the reason, why it is not in the public interface |
|
| 309 | + public function getL10nFilesForApp($app, $lang) { |
|
| 310 | + $languageFiles = []; |
|
| 311 | + |
|
| 312 | + $i18nDir = $this->findL10nDir($app); |
|
| 313 | + $transFile = strip_tags($i18nDir) . strip_tags($lang) . '.json'; |
|
| 314 | + |
|
| 315 | + if (($this->isSubDirectory($transFile, $this->serverRoot . '/core/l10n/') |
|
| 316 | + || $this->isSubDirectory($transFile, $this->serverRoot . '/lib/l10n/') |
|
| 317 | + || $this->isSubDirectory($transFile, $this->serverRoot . '/settings/l10n/') |
|
| 318 | + || $this->isSubDirectory($transFile, \OC_App::getAppPath($app) . '/l10n/') |
|
| 319 | + ) |
|
| 320 | + && file_exists($transFile)) { |
|
| 321 | + // load the translations file |
|
| 322 | + $languageFiles[] = $transFile; |
|
| 323 | + } |
|
| 324 | + |
|
| 325 | + // merge with translations from theme |
|
| 326 | + $theme = $this->config->getSystemValue('theme'); |
|
| 327 | + if (!empty($theme)) { |
|
| 328 | + $transFile = $this->serverRoot . '/themes/' . $theme . substr($transFile, strlen($this->serverRoot)); |
|
| 329 | + if (file_exists($transFile)) { |
|
| 330 | + $languageFiles[] = $transFile; |
|
| 331 | + } |
|
| 332 | + } |
|
| 333 | + |
|
| 334 | + return $languageFiles; |
|
| 335 | + } |
|
| 336 | + |
|
| 337 | + /** |
|
| 338 | + * find the l10n directory |
|
| 339 | + * |
|
| 340 | + * @param string $app App id or empty string for core |
|
| 341 | + * @return string directory |
|
| 342 | + */ |
|
| 343 | + protected function findL10nDir($app = null) { |
|
| 344 | + if (in_array($app, ['core', 'lib', 'settings'])) { |
|
| 345 | + if (file_exists($this->serverRoot . '/' . $app . '/l10n/')) { |
|
| 346 | + return $this->serverRoot . '/' . $app . '/l10n/'; |
|
| 347 | + } |
|
| 348 | + } else if ($app && \OC_App::getAppPath($app) !== false) { |
|
| 349 | + // Check if the app is in the app folder |
|
| 350 | + return \OC_App::getAppPath($app) . '/l10n/'; |
|
| 351 | + } |
|
| 352 | + return $this->serverRoot . '/core/l10n/'; |
|
| 353 | + } |
|
| 354 | + |
|
| 355 | + |
|
| 356 | + /** |
|
| 357 | + * Creates a function from the plural string |
|
| 358 | + * |
|
| 359 | + * Parts of the code is copied from Habari: |
|
| 360 | + * https://github.com/habari/system/blob/master/classes/locale.php |
|
| 361 | + * @param string $string |
|
| 362 | + * @return string |
|
| 363 | + */ |
|
| 364 | + public function createPluralFunction($string) { |
|
| 365 | + if (isset($this->pluralFunctions[$string])) { |
|
| 366 | + return $this->pluralFunctions[$string]; |
|
| 367 | + } |
|
| 368 | + |
|
| 369 | + if (preg_match( '/^\s*nplurals\s*=\s*(\d+)\s*;\s*plural=(.*)$/u', $string, $matches)) { |
|
| 370 | + // sanitize |
|
| 371 | + $nplurals = preg_replace( '/[^0-9]/', '', $matches[1] ); |
|
| 372 | + $plural = preg_replace( '#[^n0-9:\(\)\?\|\&=!<>+*/\%-]#', '', $matches[2] ); |
|
| 373 | + |
|
| 374 | + $body = str_replace( |
|
| 375 | + array( 'plural', 'n', '$n$plurals', ), |
|
| 376 | + array( '$plural', '$n', '$nplurals', ), |
|
| 377 | + 'nplurals='. $nplurals . '; plural=' . $plural |
|
| 378 | + ); |
|
| 379 | + |
|
| 380 | + // add parents |
|
| 381 | + // important since PHP's ternary evaluates from left to right |
|
| 382 | + $body .= ';'; |
|
| 383 | + $res = ''; |
|
| 384 | + $p = 0; |
|
| 385 | + for($i = 0; $i < strlen($body); $i++) { |
|
| 386 | + $ch = $body[$i]; |
|
| 387 | + switch ( $ch ) { |
|
| 388 | + case '?': |
|
| 389 | + $res .= ' ? ('; |
|
| 390 | + $p++; |
|
| 391 | + break; |
|
| 392 | + case ':': |
|
| 393 | + $res .= ') : ('; |
|
| 394 | + break; |
|
| 395 | + case ';': |
|
| 396 | + $res .= str_repeat( ')', $p ) . ';'; |
|
| 397 | + $p = 0; |
|
| 398 | + break; |
|
| 399 | + default: |
|
| 400 | + $res .= $ch; |
|
| 401 | + } |
|
| 402 | + } |
|
| 403 | + |
|
| 404 | + $body = $res . 'return ($plural>=$nplurals?$nplurals-1:$plural);'; |
|
| 405 | + $function = create_function('$n', $body); |
|
| 406 | + $this->pluralFunctions[$string] = $function; |
|
| 407 | + return $function; |
|
| 408 | + } else { |
|
| 409 | + // default: one plural form for all cases but n==1 (english) |
|
| 410 | + $function = create_function( |
|
| 411 | + '$n', |
|
| 412 | + '$nplurals=2;$plural=($n==1?0:1);return ($plural>=$nplurals?$nplurals-1:$plural);' |
|
| 413 | + ); |
|
| 414 | + $this->pluralFunctions[$string] = $function; |
|
| 415 | + return $function; |
|
| 416 | + } |
|
| 417 | + } |
|
| 418 | 418 | } |
@@ -110,6 +110,9 @@ |
||
| 110 | 110 | return parent::moveFromCache($sourceCache, $sourcePath, $targetPath); |
| 111 | 111 | } |
| 112 | 112 | |
| 113 | + /** |
|
| 114 | + * @param ICacheEntry $entry |
|
| 115 | + */ |
|
| 113 | 116 | protected function formatCacheEntry($entry) { |
| 114 | 117 | $path = isset($entry['path']) ? $entry['path'] : ''; |
| 115 | 118 | $entry = parent::formatCacheEntry($entry); |
@@ -37,112 +37,112 @@ |
||
| 37 | 37 | * don't use this class directly if you need to get metadata, use \OC\Files\Filesystem::getFileInfo instead |
| 38 | 38 | */ |
| 39 | 39 | class Cache extends CacheJail { |
| 40 | - /** |
|
| 41 | - * @var \OCA\Files_Sharing\SharedStorage |
|
| 42 | - */ |
|
| 43 | - private $storage; |
|
| 44 | - |
|
| 45 | - /** |
|
| 46 | - * @var ICacheEntry |
|
| 47 | - */ |
|
| 48 | - private $sourceRootInfo; |
|
| 49 | - |
|
| 50 | - private $rootUnchanged = true; |
|
| 51 | - |
|
| 52 | - private $ownerDisplayName; |
|
| 53 | - |
|
| 54 | - private $numericId; |
|
| 55 | - |
|
| 56 | - /** |
|
| 57 | - * @param \OCA\Files_Sharing\SharedStorage $storage |
|
| 58 | - * @param ICacheEntry $sourceRootInfo |
|
| 59 | - */ |
|
| 60 | - public function __construct($storage, ICacheEntry $sourceRootInfo) { |
|
| 61 | - $this->storage = $storage; |
|
| 62 | - $this->sourceRootInfo = $sourceRootInfo; |
|
| 63 | - $this->numericId = $sourceRootInfo->getStorageId(); |
|
| 64 | - parent::__construct( |
|
| 65 | - null, |
|
| 66 | - $this->sourceRootInfo->getPath() |
|
| 67 | - ); |
|
| 68 | - } |
|
| 69 | - |
|
| 70 | - public function getCache() { |
|
| 71 | - if (is_null($this->cache)) { |
|
| 72 | - $sourceStorage = $this->storage->getSourceStorage(); |
|
| 73 | - if ($sourceStorage) { |
|
| 74 | - $this->cache = $sourceStorage->getCache(); |
|
| 75 | - } else { |
|
| 76 | - // don't set $this->cache here since sourceStorage will be set later |
|
| 77 | - return new FailedCache(); |
|
| 78 | - } |
|
| 79 | - } |
|
| 80 | - return $this->cache; |
|
| 81 | - } |
|
| 82 | - |
|
| 83 | - public function getNumericStorageId() { |
|
| 84 | - if (isset($this->numericId)) { |
|
| 85 | - return $this->numericId; |
|
| 86 | - } else { |
|
| 87 | - return false; |
|
| 88 | - } |
|
| 89 | - } |
|
| 90 | - |
|
| 91 | - public function get($file) { |
|
| 92 | - if ($this->rootUnchanged && ($file === '' || $file === $this->sourceRootInfo->getId())) { |
|
| 93 | - return $this->formatCacheEntry(clone $this->sourceRootInfo); |
|
| 94 | - } |
|
| 95 | - return parent::get($file); |
|
| 96 | - } |
|
| 97 | - |
|
| 98 | - public function update($id, array $data) { |
|
| 99 | - $this->rootUnchanged = false; |
|
| 100 | - parent::update($id, $data); |
|
| 101 | - } |
|
| 102 | - |
|
| 103 | - public function insert($file, array $data) { |
|
| 104 | - $this->rootUnchanged = false; |
|
| 105 | - return parent::insert($file, $data); |
|
| 106 | - } |
|
| 107 | - |
|
| 108 | - public function remove($file) { |
|
| 109 | - $this->rootUnchanged = false; |
|
| 110 | - parent::remove($file); |
|
| 111 | - } |
|
| 112 | - |
|
| 113 | - public function moveFromCache(\OCP\Files\Cache\ICache $sourceCache, $sourcePath, $targetPath) { |
|
| 114 | - $this->rootUnchanged = false; |
|
| 115 | - return parent::moveFromCache($sourceCache, $sourcePath, $targetPath); |
|
| 116 | - } |
|
| 117 | - |
|
| 118 | - protected function formatCacheEntry($entry) { |
|
| 119 | - $path = isset($entry['path']) ? $entry['path'] : ''; |
|
| 120 | - $entry = parent::formatCacheEntry($entry); |
|
| 121 | - $sharePermissions = $this->storage->getPermissions($path); |
|
| 122 | - if (isset($entry['permissions'])) { |
|
| 123 | - $entry['permissions'] &= $sharePermissions; |
|
| 124 | - } else { |
|
| 125 | - $entry['permissions'] = $sharePermissions; |
|
| 126 | - } |
|
| 127 | - $entry['uid_owner'] = $this->storage->getOwner($path); |
|
| 128 | - $entry['displayname_owner'] = $this->getOwnerDisplayName(); |
|
| 129 | - if ($path === '') { |
|
| 130 | - $entry['is_share_mount_point'] = true; |
|
| 131 | - } |
|
| 132 | - return $entry; |
|
| 133 | - } |
|
| 134 | - |
|
| 135 | - private function getOwnerDisplayName() { |
|
| 136 | - if (!$this->ownerDisplayName) { |
|
| 137 | - $this->ownerDisplayName = \OC_User::getDisplayName($this->storage->getOwner('')); |
|
| 138 | - } |
|
| 139 | - return $this->ownerDisplayName; |
|
| 140 | - } |
|
| 141 | - |
|
| 142 | - /** |
|
| 143 | - * remove all entries for files that are stored on the storage from the cache |
|
| 144 | - */ |
|
| 145 | - public function clear() { |
|
| 146 | - // Not a valid action for Shared Cache |
|
| 147 | - } |
|
| 40 | + /** |
|
| 41 | + * @var \OCA\Files_Sharing\SharedStorage |
|
| 42 | + */ |
|
| 43 | + private $storage; |
|
| 44 | + |
|
| 45 | + /** |
|
| 46 | + * @var ICacheEntry |
|
| 47 | + */ |
|
| 48 | + private $sourceRootInfo; |
|
| 49 | + |
|
| 50 | + private $rootUnchanged = true; |
|
| 51 | + |
|
| 52 | + private $ownerDisplayName; |
|
| 53 | + |
|
| 54 | + private $numericId; |
|
| 55 | + |
|
| 56 | + /** |
|
| 57 | + * @param \OCA\Files_Sharing\SharedStorage $storage |
|
| 58 | + * @param ICacheEntry $sourceRootInfo |
|
| 59 | + */ |
|
| 60 | + public function __construct($storage, ICacheEntry $sourceRootInfo) { |
|
| 61 | + $this->storage = $storage; |
|
| 62 | + $this->sourceRootInfo = $sourceRootInfo; |
|
| 63 | + $this->numericId = $sourceRootInfo->getStorageId(); |
|
| 64 | + parent::__construct( |
|
| 65 | + null, |
|
| 66 | + $this->sourceRootInfo->getPath() |
|
| 67 | + ); |
|
| 68 | + } |
|
| 69 | + |
|
| 70 | + public function getCache() { |
|
| 71 | + if (is_null($this->cache)) { |
|
| 72 | + $sourceStorage = $this->storage->getSourceStorage(); |
|
| 73 | + if ($sourceStorage) { |
|
| 74 | + $this->cache = $sourceStorage->getCache(); |
|
| 75 | + } else { |
|
| 76 | + // don't set $this->cache here since sourceStorage will be set later |
|
| 77 | + return new FailedCache(); |
|
| 78 | + } |
|
| 79 | + } |
|
| 80 | + return $this->cache; |
|
| 81 | + } |
|
| 82 | + |
|
| 83 | + public function getNumericStorageId() { |
|
| 84 | + if (isset($this->numericId)) { |
|
| 85 | + return $this->numericId; |
|
| 86 | + } else { |
|
| 87 | + return false; |
|
| 88 | + } |
|
| 89 | + } |
|
| 90 | + |
|
| 91 | + public function get($file) { |
|
| 92 | + if ($this->rootUnchanged && ($file === '' || $file === $this->sourceRootInfo->getId())) { |
|
| 93 | + return $this->formatCacheEntry(clone $this->sourceRootInfo); |
|
| 94 | + } |
|
| 95 | + return parent::get($file); |
|
| 96 | + } |
|
| 97 | + |
|
| 98 | + public function update($id, array $data) { |
|
| 99 | + $this->rootUnchanged = false; |
|
| 100 | + parent::update($id, $data); |
|
| 101 | + } |
|
| 102 | + |
|
| 103 | + public function insert($file, array $data) { |
|
| 104 | + $this->rootUnchanged = false; |
|
| 105 | + return parent::insert($file, $data); |
|
| 106 | + } |
|
| 107 | + |
|
| 108 | + public function remove($file) { |
|
| 109 | + $this->rootUnchanged = false; |
|
| 110 | + parent::remove($file); |
|
| 111 | + } |
|
| 112 | + |
|
| 113 | + public function moveFromCache(\OCP\Files\Cache\ICache $sourceCache, $sourcePath, $targetPath) { |
|
| 114 | + $this->rootUnchanged = false; |
|
| 115 | + return parent::moveFromCache($sourceCache, $sourcePath, $targetPath); |
|
| 116 | + } |
|
| 117 | + |
|
| 118 | + protected function formatCacheEntry($entry) { |
|
| 119 | + $path = isset($entry['path']) ? $entry['path'] : ''; |
|
| 120 | + $entry = parent::formatCacheEntry($entry); |
|
| 121 | + $sharePermissions = $this->storage->getPermissions($path); |
|
| 122 | + if (isset($entry['permissions'])) { |
|
| 123 | + $entry['permissions'] &= $sharePermissions; |
|
| 124 | + } else { |
|
| 125 | + $entry['permissions'] = $sharePermissions; |
|
| 126 | + } |
|
| 127 | + $entry['uid_owner'] = $this->storage->getOwner($path); |
|
| 128 | + $entry['displayname_owner'] = $this->getOwnerDisplayName(); |
|
| 129 | + if ($path === '') { |
|
| 130 | + $entry['is_share_mount_point'] = true; |
|
| 131 | + } |
|
| 132 | + return $entry; |
|
| 133 | + } |
|
| 134 | + |
|
| 135 | + private function getOwnerDisplayName() { |
|
| 136 | + if (!$this->ownerDisplayName) { |
|
| 137 | + $this->ownerDisplayName = \OC_User::getDisplayName($this->storage->getOwner('')); |
|
| 138 | + } |
|
| 139 | + return $this->ownerDisplayName; |
|
| 140 | + } |
|
| 141 | + |
|
| 142 | + /** |
|
| 143 | + * remove all entries for files that are stored on the storage from the cache |
|
| 144 | + */ |
|
| 145 | + public function clear() { |
|
| 146 | + // Not a valid action for Shared Cache |
|
| 147 | + } |
|
| 148 | 148 | } |
@@ -360,6 +360,9 @@ discard block |
||
| 360 | 360 | } |
| 361 | 361 | } |
| 362 | 362 | |
| 363 | + /** |
|
| 364 | + * @param string $root |
|
| 365 | + */ |
|
| 363 | 366 | static public function init($user, $root) { |
| 364 | 367 | if (self::$defaultInstance) { |
| 365 | 368 | return false; |
@@ -528,7 +531,7 @@ discard block |
||
| 528 | 531 | /** |
| 529 | 532 | * mount an \OC\Files\Storage\Storage in our virtual filesystem |
| 530 | 533 | * |
| 531 | - * @param \OC\Files\Storage\Storage|string $class |
|
| 534 | + * @param string $class |
|
| 532 | 535 | * @param array $arguments |
| 533 | 536 | * @param string $mountpoint |
| 534 | 537 | */ |
@@ -660,6 +663,9 @@ discard block |
||
| 660 | 663 | return self::$defaultInstance->is_dir($path); |
| 661 | 664 | } |
| 662 | 665 | |
| 666 | + /** |
|
| 667 | + * @param string $path |
|
| 668 | + */ |
|
| 663 | 669 | static public function is_file($path) { |
| 664 | 670 | return self::$defaultInstance->is_file($path); |
| 665 | 671 | } |
@@ -672,6 +678,9 @@ discard block |
||
| 672 | 678 | return self::$defaultInstance->filetype($path); |
| 673 | 679 | } |
| 674 | 680 | |
| 681 | + /** |
|
| 682 | + * @param string $path |
|
| 683 | + */ |
|
| 675 | 684 | static public function filesize($path) { |
| 676 | 685 | return self::$defaultInstance->filesize($path); |
| 677 | 686 | } |
@@ -684,6 +693,9 @@ discard block |
||
| 684 | 693 | return self::$defaultInstance->isCreatable($path); |
| 685 | 694 | } |
| 686 | 695 | |
| 696 | + /** |
|
| 697 | + * @param string $path |
|
| 698 | + */ |
|
| 687 | 699 | static public function isReadable($path) { |
| 688 | 700 | return self::$defaultInstance->isReadable($path); |
| 689 | 701 | } |
@@ -696,6 +708,9 @@ discard block |
||
| 696 | 708 | return self::$defaultInstance->isDeletable($path); |
| 697 | 709 | } |
| 698 | 710 | |
| 711 | + /** |
|
| 712 | + * @param string $path |
|
| 713 | + */ |
|
| 699 | 714 | static public function isSharable($path) { |
| 700 | 715 | return self::$defaultInstance->isSharable($path); |
| 701 | 716 | } |
@@ -704,6 +719,9 @@ discard block |
||
| 704 | 719 | return self::$defaultInstance->file_exists($path); |
| 705 | 720 | } |
| 706 | 721 | |
| 722 | + /** |
|
| 723 | + * @param string $path |
|
| 724 | + */ |
|
| 707 | 725 | static public function filemtime($path) { |
| 708 | 726 | return self::$defaultInstance->filemtime($path); |
| 709 | 727 | } |
@@ -713,6 +731,7 @@ discard block |
||
| 713 | 731 | } |
| 714 | 732 | |
| 715 | 733 | /** |
| 734 | + * @param string $path |
|
| 716 | 735 | * @return string |
| 717 | 736 | */ |
| 718 | 737 | static public function file_get_contents($path) { |
@@ -735,6 +754,10 @@ discard block |
||
| 735 | 754 | return self::$defaultInstance->copy($path1, $path2); |
| 736 | 755 | } |
| 737 | 756 | |
| 757 | + /** |
|
| 758 | + * @param string $path |
|
| 759 | + * @param string $mode |
|
| 760 | + */ |
|
| 738 | 761 | static public function fopen($path, $mode) { |
| 739 | 762 | return self::$defaultInstance->fopen($path, $mode); |
| 740 | 763 | } |
@@ -750,6 +773,9 @@ discard block |
||
| 750 | 773 | return self::$defaultInstance->fromTmpFile($tmpFile, $path); |
| 751 | 774 | } |
| 752 | 775 | |
| 776 | + /** |
|
| 777 | + * @param string $path |
|
| 778 | + */ |
|
| 753 | 779 | static public function getMimeType($path) { |
| 754 | 780 | return self::$defaultInstance->getMimeType($path); |
| 755 | 781 | } |
@@ -762,6 +788,9 @@ discard block |
||
| 762 | 788 | return self::$defaultInstance->free_space($path); |
| 763 | 789 | } |
| 764 | 790 | |
| 791 | + /** |
|
| 792 | + * @param string $query |
|
| 793 | + */ |
|
| 765 | 794 | static public function search($query) { |
| 766 | 795 | return self::$defaultInstance->search($query); |
| 767 | 796 | } |
@@ -870,7 +899,7 @@ discard block |
||
| 870 | 899 | * @param string $path |
| 871 | 900 | * @param boolean $includeMountPoints whether to add mountpoint sizes, |
| 872 | 901 | * defaults to true |
| 873 | - * @return \OC\Files\FileInfo|bool False if file does not exist |
|
| 902 | + * @return \OCP\Files\FileInfo|null False if file does not exist |
|
| 874 | 903 | */ |
| 875 | 904 | public static function getFileInfo($path, $includeMountPoints = true) { |
| 876 | 905 | return self::$defaultInstance->getFileInfo($path, $includeMountPoints); |
@@ -409,17 +409,17 @@ discard block |
||
| 409 | 409 | $userObject = $userManager->get($user); |
| 410 | 410 | |
| 411 | 411 | if (is_null($userObject)) { |
| 412 | - \OCP\Util::writeLog('files', ' Backends provided no user object for ' . $user, \OCP\Util::ERROR); |
|
| 412 | + \OCP\Util::writeLog('files', ' Backends provided no user object for '.$user, \OCP\Util::ERROR); |
|
| 413 | 413 | // reset flag, this will make it possible to rethrow the exception if called again |
| 414 | 414 | unset(self::$usersSetup[$user]); |
| 415 | - throw new \OC\User\NoUserException('Backends provided no user object for ' . $user); |
|
| 415 | + throw new \OC\User\NoUserException('Backends provided no user object for '.$user); |
|
| 416 | 416 | } |
| 417 | 417 | |
| 418 | 418 | $realUid = $userObject->getUID(); |
| 419 | 419 | // workaround in case of different casings |
| 420 | 420 | if ($user !== $realUid) { |
| 421 | 421 | $stack = json_encode(debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 50)); |
| 422 | - \OCP\Util::writeLog('files', 'initMountPoints() called with wrong user casing. This could be a bug. Expected: "' . $realUid . '" got "' . $user . '". Stack: ' . $stack, \OCP\Util::WARN); |
|
| 422 | + \OCP\Util::writeLog('files', 'initMountPoints() called with wrong user casing. This could be a bug. Expected: "'.$realUid.'" got "'.$user.'". Stack: '.$stack, \OCP\Util::WARN); |
|
| 423 | 423 | $user = $realUid; |
| 424 | 424 | |
| 425 | 425 | // again with the correct casing |
@@ -453,11 +453,11 @@ discard block |
||
| 453 | 453 | } else { |
| 454 | 454 | self::getMountManager()->addMount(new MountPoint( |
| 455 | 455 | new NullStorage([]), |
| 456 | - '/' . $user |
|
| 456 | + '/'.$user |
|
| 457 | 457 | )); |
| 458 | 458 | self::getMountManager()->addMount(new MountPoint( |
| 459 | 459 | new NullStorage([]), |
| 460 | - '/' . $user . '/files' |
|
| 460 | + '/'.$user.'/files' |
|
| 461 | 461 | )); |
| 462 | 462 | } |
| 463 | 463 | \OC_Hook::emit('OC_Filesystem', 'post_initMountPoints', array('user' => $user)); |
@@ -472,7 +472,7 @@ discard block |
||
| 472 | 472 | private static function listenForNewMountProviders(MountProviderCollection $mountConfigManager, IUserManager $userManager) { |
| 473 | 473 | if (!self::$listeningForProviders) { |
| 474 | 474 | self::$listeningForProviders = true; |
| 475 | - $mountConfigManager->listen('\OC\Files\Config', 'registerMountProvider', function (IMountProvider $provider) use ($userManager) { |
|
| 475 | + $mountConfigManager->listen('\OC\Files\Config', 'registerMountProvider', function(IMountProvider $provider) use ($userManager) { |
|
| 476 | 476 | foreach (Filesystem::$usersSetup as $user => $setup) { |
| 477 | 477 | $userObject = $userManager->get($user); |
| 478 | 478 | if ($userObject) { |
@@ -567,7 +567,7 @@ discard block |
||
| 567 | 567 | * @return string |
| 568 | 568 | */ |
| 569 | 569 | static public function getLocalPath($path) { |
| 570 | - $datadir = \OC_User::getHome(\OC_User::getUser()) . '/files'; |
|
| 570 | + $datadir = \OC_User::getHome(\OC_User::getUser()).'/files'; |
|
| 571 | 571 | $newpath = $path; |
| 572 | 572 | if (strncmp($newpath, $datadir, strlen($datadir)) == 0) { |
| 573 | 573 | $newpath = substr($path, strlen($datadir)); |
@@ -584,7 +584,7 @@ discard block |
||
| 584 | 584 | static public function isValidPath($path) { |
| 585 | 585 | $path = self::normalizePath($path); |
| 586 | 586 | if (!$path || $path[0] !== '/') { |
| 587 | - $path = '/' . $path; |
|
| 587 | + $path = '/'.$path; |
|
| 588 | 588 | } |
| 589 | 589 | if (strpos($path, '/../') !== false || strrchr($path, '/') === '/..') { |
| 590 | 590 | return false; |
@@ -813,7 +813,7 @@ discard block |
||
| 813 | 813 | * conversion should get removed as soon as all existing |
| 814 | 814 | * function calls have been fixed. |
| 815 | 815 | */ |
| 816 | - $path = (string)$path; |
|
| 816 | + $path = (string) $path; |
|
| 817 | 817 | |
| 818 | 818 | $cacheKey = json_encode([$path, $stripTrailingSlash, $isAbsolutePath, $keepUnicode]); |
| 819 | 819 | |
@@ -835,7 +835,7 @@ discard block |
||
| 835 | 835 | |
| 836 | 836 | //add leading slash |
| 837 | 837 | if ($path[0] !== '/') { |
| 838 | - $path = '/' . $path; |
|
| 838 | + $path = '/'.$path; |
|
| 839 | 839 | } |
| 840 | 840 | |
| 841 | 841 | // remove '/./' |
@@ -69,857 +69,857 @@ |
||
| 69 | 69 | |
| 70 | 70 | class Filesystem { |
| 71 | 71 | |
| 72 | - /** |
|
| 73 | - * @var Mount\Manager $mounts |
|
| 74 | - */ |
|
| 75 | - private static $mounts; |
|
| 76 | - |
|
| 77 | - public static $loaded = false; |
|
| 78 | - /** |
|
| 79 | - * @var \OC\Files\View $defaultInstance |
|
| 80 | - */ |
|
| 81 | - static private $defaultInstance; |
|
| 82 | - |
|
| 83 | - static private $usersSetup = array(); |
|
| 84 | - |
|
| 85 | - static private $normalizedPathCache = null; |
|
| 86 | - |
|
| 87 | - static private $listeningForProviders = false; |
|
| 88 | - |
|
| 89 | - /** |
|
| 90 | - * classname which used for hooks handling |
|
| 91 | - * used as signalclass in OC_Hooks::emit() |
|
| 92 | - */ |
|
| 93 | - const CLASSNAME = 'OC_Filesystem'; |
|
| 94 | - |
|
| 95 | - /** |
|
| 96 | - * signalname emitted before file renaming |
|
| 97 | - * |
|
| 98 | - * @param string $oldpath |
|
| 99 | - * @param string $newpath |
|
| 100 | - */ |
|
| 101 | - const signal_rename = 'rename'; |
|
| 102 | - |
|
| 103 | - /** |
|
| 104 | - * signal emitted after file renaming |
|
| 105 | - * |
|
| 106 | - * @param string $oldpath |
|
| 107 | - * @param string $newpath |
|
| 108 | - */ |
|
| 109 | - const signal_post_rename = 'post_rename'; |
|
| 110 | - |
|
| 111 | - /** |
|
| 112 | - * signal emitted before file/dir creation |
|
| 113 | - * |
|
| 114 | - * @param string $path |
|
| 115 | - * @param bool $run changing this flag to false in hook handler will cancel event |
|
| 116 | - */ |
|
| 117 | - const signal_create = 'create'; |
|
| 118 | - |
|
| 119 | - /** |
|
| 120 | - * signal emitted after file/dir creation |
|
| 121 | - * |
|
| 122 | - * @param string $path |
|
| 123 | - * @param bool $run changing this flag to false in hook handler will cancel event |
|
| 124 | - */ |
|
| 125 | - const signal_post_create = 'post_create'; |
|
| 126 | - |
|
| 127 | - /** |
|
| 128 | - * signal emits before file/dir copy |
|
| 129 | - * |
|
| 130 | - * @param string $oldpath |
|
| 131 | - * @param string $newpath |
|
| 132 | - * @param bool $run changing this flag to false in hook handler will cancel event |
|
| 133 | - */ |
|
| 134 | - const signal_copy = 'copy'; |
|
| 135 | - |
|
| 136 | - /** |
|
| 137 | - * signal emits after file/dir copy |
|
| 138 | - * |
|
| 139 | - * @param string $oldpath |
|
| 140 | - * @param string $newpath |
|
| 141 | - */ |
|
| 142 | - const signal_post_copy = 'post_copy'; |
|
| 143 | - |
|
| 144 | - /** |
|
| 145 | - * signal emits before file/dir save |
|
| 146 | - * |
|
| 147 | - * @param string $path |
|
| 148 | - * @param bool $run changing this flag to false in hook handler will cancel event |
|
| 149 | - */ |
|
| 150 | - const signal_write = 'write'; |
|
| 151 | - |
|
| 152 | - /** |
|
| 153 | - * signal emits after file/dir save |
|
| 154 | - * |
|
| 155 | - * @param string $path |
|
| 156 | - */ |
|
| 157 | - const signal_post_write = 'post_write'; |
|
| 158 | - |
|
| 159 | - /** |
|
| 160 | - * signal emitted before file/dir update |
|
| 161 | - * |
|
| 162 | - * @param string $path |
|
| 163 | - * @param bool $run changing this flag to false in hook handler will cancel event |
|
| 164 | - */ |
|
| 165 | - const signal_update = 'update'; |
|
| 166 | - |
|
| 167 | - /** |
|
| 168 | - * signal emitted after file/dir update |
|
| 169 | - * |
|
| 170 | - * @param string $path |
|
| 171 | - * @param bool $run changing this flag to false in hook handler will cancel event |
|
| 172 | - */ |
|
| 173 | - const signal_post_update = 'post_update'; |
|
| 174 | - |
|
| 175 | - /** |
|
| 176 | - * signal emits when reading file/dir |
|
| 177 | - * |
|
| 178 | - * @param string $path |
|
| 179 | - */ |
|
| 180 | - const signal_read = 'read'; |
|
| 181 | - |
|
| 182 | - /** |
|
| 183 | - * signal emits when removing file/dir |
|
| 184 | - * |
|
| 185 | - * @param string $path |
|
| 186 | - */ |
|
| 187 | - const signal_delete = 'delete'; |
|
| 188 | - |
|
| 189 | - /** |
|
| 190 | - * parameters definitions for signals |
|
| 191 | - */ |
|
| 192 | - const signal_param_path = 'path'; |
|
| 193 | - const signal_param_oldpath = 'oldpath'; |
|
| 194 | - const signal_param_newpath = 'newpath'; |
|
| 195 | - |
|
| 196 | - /** |
|
| 197 | - * run - changing this flag to false in hook handler will cancel event |
|
| 198 | - */ |
|
| 199 | - const signal_param_run = 'run'; |
|
| 200 | - |
|
| 201 | - const signal_create_mount = 'create_mount'; |
|
| 202 | - const signal_delete_mount = 'delete_mount'; |
|
| 203 | - const signal_param_mount_type = 'mounttype'; |
|
| 204 | - const signal_param_users = 'users'; |
|
| 205 | - |
|
| 206 | - /** |
|
| 207 | - * @var \OC\Files\Storage\StorageFactory $loader |
|
| 208 | - */ |
|
| 209 | - private static $loader; |
|
| 210 | - |
|
| 211 | - /** @var bool */ |
|
| 212 | - private static $logWarningWhenAddingStorageWrapper = true; |
|
| 213 | - |
|
| 214 | - /** |
|
| 215 | - * @param bool $shouldLog |
|
| 216 | - * @return bool previous value |
|
| 217 | - * @internal |
|
| 218 | - */ |
|
| 219 | - public static function logWarningWhenAddingStorageWrapper($shouldLog) { |
|
| 220 | - $previousValue = self::$logWarningWhenAddingStorageWrapper; |
|
| 221 | - self::$logWarningWhenAddingStorageWrapper = (bool) $shouldLog; |
|
| 222 | - return $previousValue; |
|
| 223 | - } |
|
| 224 | - |
|
| 225 | - /** |
|
| 226 | - * @param string $wrapperName |
|
| 227 | - * @param callable $wrapper |
|
| 228 | - * @param int $priority |
|
| 229 | - */ |
|
| 230 | - public static function addStorageWrapper($wrapperName, $wrapper, $priority = 50) { |
|
| 231 | - if (self::$logWarningWhenAddingStorageWrapper) { |
|
| 232 | - \OC::$server->getLogger()->warning("Storage wrapper '{wrapper}' was not registered via the 'OC_Filesystem - preSetup' hook which could cause potential problems.", [ |
|
| 233 | - 'wrapper' => $wrapperName, |
|
| 234 | - 'app' => 'filesystem', |
|
| 235 | - ]); |
|
| 236 | - } |
|
| 237 | - |
|
| 238 | - $mounts = self::getMountManager()->getAll(); |
|
| 239 | - if (!self::getLoader()->addStorageWrapper($wrapperName, $wrapper, $priority, $mounts)) { |
|
| 240 | - // do not re-wrap if storage with this name already existed |
|
| 241 | - return; |
|
| 242 | - } |
|
| 243 | - } |
|
| 244 | - |
|
| 245 | - /** |
|
| 246 | - * Returns the storage factory |
|
| 247 | - * |
|
| 248 | - * @return \OCP\Files\Storage\IStorageFactory |
|
| 249 | - */ |
|
| 250 | - public static function getLoader() { |
|
| 251 | - if (!self::$loader) { |
|
| 252 | - self::$loader = new StorageFactory(); |
|
| 253 | - } |
|
| 254 | - return self::$loader; |
|
| 255 | - } |
|
| 256 | - |
|
| 257 | - /** |
|
| 258 | - * Returns the mount manager |
|
| 259 | - * |
|
| 260 | - * @return \OC\Files\Mount\Manager |
|
| 261 | - */ |
|
| 262 | - public static function getMountManager($user = '') { |
|
| 263 | - if (!self::$mounts) { |
|
| 264 | - \OC_Util::setupFS($user); |
|
| 265 | - } |
|
| 266 | - return self::$mounts; |
|
| 267 | - } |
|
| 268 | - |
|
| 269 | - /** |
|
| 270 | - * get the mountpoint of the storage object for a path |
|
| 271 | - * ( note: because a storage is not always mounted inside the fakeroot, the |
|
| 272 | - * returned mountpoint is relative to the absolute root of the filesystem |
|
| 273 | - * and doesn't take the chroot into account ) |
|
| 274 | - * |
|
| 275 | - * @param string $path |
|
| 276 | - * @return string |
|
| 277 | - */ |
|
| 278 | - static public function getMountPoint($path) { |
|
| 279 | - if (!self::$mounts) { |
|
| 280 | - \OC_Util::setupFS(); |
|
| 281 | - } |
|
| 282 | - $mount = self::$mounts->find($path); |
|
| 283 | - if ($mount) { |
|
| 284 | - return $mount->getMountPoint(); |
|
| 285 | - } else { |
|
| 286 | - return ''; |
|
| 287 | - } |
|
| 288 | - } |
|
| 289 | - |
|
| 290 | - /** |
|
| 291 | - * get a list of all mount points in a directory |
|
| 292 | - * |
|
| 293 | - * @param string $path |
|
| 294 | - * @return string[] |
|
| 295 | - */ |
|
| 296 | - static public function getMountPoints($path) { |
|
| 297 | - if (!self::$mounts) { |
|
| 298 | - \OC_Util::setupFS(); |
|
| 299 | - } |
|
| 300 | - $result = array(); |
|
| 301 | - $mounts = self::$mounts->findIn($path); |
|
| 302 | - foreach ($mounts as $mount) { |
|
| 303 | - $result[] = $mount->getMountPoint(); |
|
| 304 | - } |
|
| 305 | - return $result; |
|
| 306 | - } |
|
| 307 | - |
|
| 308 | - /** |
|
| 309 | - * get the storage mounted at $mountPoint |
|
| 310 | - * |
|
| 311 | - * @param string $mountPoint |
|
| 312 | - * @return \OC\Files\Storage\Storage |
|
| 313 | - */ |
|
| 314 | - public static function getStorage($mountPoint) { |
|
| 315 | - if (!self::$mounts) { |
|
| 316 | - \OC_Util::setupFS(); |
|
| 317 | - } |
|
| 318 | - $mount = self::$mounts->find($mountPoint); |
|
| 319 | - return $mount->getStorage(); |
|
| 320 | - } |
|
| 321 | - |
|
| 322 | - /** |
|
| 323 | - * @param string $id |
|
| 324 | - * @return Mount\MountPoint[] |
|
| 325 | - */ |
|
| 326 | - public static function getMountByStorageId($id) { |
|
| 327 | - if (!self::$mounts) { |
|
| 328 | - \OC_Util::setupFS(); |
|
| 329 | - } |
|
| 330 | - return self::$mounts->findByStorageId($id); |
|
| 331 | - } |
|
| 332 | - |
|
| 333 | - /** |
|
| 334 | - * @param int $id |
|
| 335 | - * @return Mount\MountPoint[] |
|
| 336 | - */ |
|
| 337 | - public static function getMountByNumericId($id) { |
|
| 338 | - if (!self::$mounts) { |
|
| 339 | - \OC_Util::setupFS(); |
|
| 340 | - } |
|
| 341 | - return self::$mounts->findByNumericId($id); |
|
| 342 | - } |
|
| 343 | - |
|
| 344 | - /** |
|
| 345 | - * resolve a path to a storage and internal path |
|
| 346 | - * |
|
| 347 | - * @param string $path |
|
| 348 | - * @return array an array consisting of the storage and the internal path |
|
| 349 | - */ |
|
| 350 | - static public function resolvePath($path) { |
|
| 351 | - if (!self::$mounts) { |
|
| 352 | - \OC_Util::setupFS(); |
|
| 353 | - } |
|
| 354 | - $mount = self::$mounts->find($path); |
|
| 355 | - if ($mount) { |
|
| 356 | - return array($mount->getStorage(), rtrim($mount->getInternalPath($path), '/')); |
|
| 357 | - } else { |
|
| 358 | - return array(null, null); |
|
| 359 | - } |
|
| 360 | - } |
|
| 361 | - |
|
| 362 | - static public function init($user, $root) { |
|
| 363 | - if (self::$defaultInstance) { |
|
| 364 | - return false; |
|
| 365 | - } |
|
| 366 | - self::getLoader(); |
|
| 367 | - self::$defaultInstance = new View($root); |
|
| 368 | - |
|
| 369 | - if (!self::$mounts) { |
|
| 370 | - self::$mounts = \OC::$server->getMountManager(); |
|
| 371 | - } |
|
| 372 | - |
|
| 373 | - //load custom mount config |
|
| 374 | - self::initMountPoints($user); |
|
| 375 | - |
|
| 376 | - self::$loaded = true; |
|
| 377 | - |
|
| 378 | - return true; |
|
| 379 | - } |
|
| 380 | - |
|
| 381 | - static public function initMountManager() { |
|
| 382 | - if (!self::$mounts) { |
|
| 383 | - self::$mounts = \OC::$server->getMountManager(); |
|
| 384 | - } |
|
| 385 | - } |
|
| 386 | - |
|
| 387 | - /** |
|
| 388 | - * Initialize system and personal mount points for a user |
|
| 389 | - * |
|
| 390 | - * @param string $user |
|
| 391 | - * @throws \OC\User\NoUserException if the user is not available |
|
| 392 | - */ |
|
| 393 | - public static function initMountPoints($user = '') { |
|
| 394 | - if ($user == '') { |
|
| 395 | - $user = \OC_User::getUser(); |
|
| 396 | - } |
|
| 397 | - if ($user === null || $user === false || $user === '') { |
|
| 398 | - throw new \OC\User\NoUserException('Attempted to initialize mount points for null user and no user in session'); |
|
| 399 | - } |
|
| 400 | - |
|
| 401 | - if (isset(self::$usersSetup[$user])) { |
|
| 402 | - return; |
|
| 403 | - } |
|
| 404 | - |
|
| 405 | - self::$usersSetup[$user] = true; |
|
| 406 | - |
|
| 407 | - $userManager = \OC::$server->getUserManager(); |
|
| 408 | - $userObject = $userManager->get($user); |
|
| 409 | - |
|
| 410 | - if (is_null($userObject)) { |
|
| 411 | - \OCP\Util::writeLog('files', ' Backends provided no user object for ' . $user, \OCP\Util::ERROR); |
|
| 412 | - // reset flag, this will make it possible to rethrow the exception if called again |
|
| 413 | - unset(self::$usersSetup[$user]); |
|
| 414 | - throw new \OC\User\NoUserException('Backends provided no user object for ' . $user); |
|
| 415 | - } |
|
| 416 | - |
|
| 417 | - $realUid = $userObject->getUID(); |
|
| 418 | - // workaround in case of different casings |
|
| 419 | - if ($user !== $realUid) { |
|
| 420 | - $stack = json_encode(debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 50)); |
|
| 421 | - \OCP\Util::writeLog('files', 'initMountPoints() called with wrong user casing. This could be a bug. Expected: "' . $realUid . '" got "' . $user . '". Stack: ' . $stack, \OCP\Util::WARN); |
|
| 422 | - $user = $realUid; |
|
| 423 | - |
|
| 424 | - // again with the correct casing |
|
| 425 | - if (isset(self::$usersSetup[$user])) { |
|
| 426 | - return; |
|
| 427 | - } |
|
| 428 | - |
|
| 429 | - self::$usersSetup[$user] = true; |
|
| 430 | - } |
|
| 431 | - |
|
| 432 | - if (\OC::$server->getLockdownManager()->canAccessFilesystem()) { |
|
| 433 | - /** @var \OC\Files\Config\MountProviderCollection $mountConfigManager */ |
|
| 434 | - $mountConfigManager = \OC::$server->getMountProviderCollection(); |
|
| 435 | - |
|
| 436 | - // home mounts are handled seperate since we need to ensure this is mounted before we call the other mount providers |
|
| 437 | - $homeMount = $mountConfigManager->getHomeMountForUser($userObject); |
|
| 438 | - |
|
| 439 | - self::getMountManager()->addMount($homeMount); |
|
| 440 | - |
|
| 441 | - \OC\Files\Filesystem::getStorage($user); |
|
| 442 | - |
|
| 443 | - // Chance to mount for other storages |
|
| 444 | - if ($userObject) { |
|
| 445 | - $mounts = $mountConfigManager->addMountForUser($userObject, self::getMountManager()); |
|
| 446 | - $mounts[] = $homeMount; |
|
| 447 | - $mountConfigManager->registerMounts($userObject, $mounts); |
|
| 448 | - } |
|
| 449 | - |
|
| 450 | - self::listenForNewMountProviders($mountConfigManager, $userManager); |
|
| 451 | - } else { |
|
| 452 | - self::getMountManager()->addMount(new MountPoint( |
|
| 453 | - new NullStorage([]), |
|
| 454 | - '/' . $user |
|
| 455 | - )); |
|
| 456 | - self::getMountManager()->addMount(new MountPoint( |
|
| 457 | - new NullStorage([]), |
|
| 458 | - '/' . $user . '/files' |
|
| 459 | - )); |
|
| 460 | - } |
|
| 461 | - \OC_Hook::emit('OC_Filesystem', 'post_initMountPoints', array('user' => $user)); |
|
| 462 | - } |
|
| 463 | - |
|
| 464 | - /** |
|
| 465 | - * Get mounts from mount providers that are registered after setup |
|
| 466 | - * |
|
| 467 | - * @param MountProviderCollection $mountConfigManager |
|
| 468 | - * @param IUserManager $userManager |
|
| 469 | - */ |
|
| 470 | - private static function listenForNewMountProviders(MountProviderCollection $mountConfigManager, IUserManager $userManager) { |
|
| 471 | - if (!self::$listeningForProviders) { |
|
| 472 | - self::$listeningForProviders = true; |
|
| 473 | - $mountConfigManager->listen('\OC\Files\Config', 'registerMountProvider', function (IMountProvider $provider) use ($userManager) { |
|
| 474 | - foreach (Filesystem::$usersSetup as $user => $setup) { |
|
| 475 | - $userObject = $userManager->get($user); |
|
| 476 | - if ($userObject) { |
|
| 477 | - $mounts = $provider->getMountsForUser($userObject, Filesystem::getLoader()); |
|
| 478 | - array_walk($mounts, array(self::$mounts, 'addMount')); |
|
| 479 | - } |
|
| 480 | - } |
|
| 481 | - }); |
|
| 482 | - } |
|
| 483 | - } |
|
| 484 | - |
|
| 485 | - /** |
|
| 486 | - * get the default filesystem view |
|
| 487 | - * |
|
| 488 | - * @return View |
|
| 489 | - */ |
|
| 490 | - static public function getView() { |
|
| 491 | - return self::$defaultInstance; |
|
| 492 | - } |
|
| 493 | - |
|
| 494 | - /** |
|
| 495 | - * tear down the filesystem, removing all storage providers |
|
| 496 | - */ |
|
| 497 | - static public function tearDown() { |
|
| 498 | - self::clearMounts(); |
|
| 499 | - self::$defaultInstance = null; |
|
| 500 | - } |
|
| 501 | - |
|
| 502 | - /** |
|
| 503 | - * get the relative path of the root data directory for the current user |
|
| 504 | - * |
|
| 505 | - * @return string |
|
| 506 | - * |
|
| 507 | - * Returns path like /admin/files |
|
| 508 | - */ |
|
| 509 | - static public function getRoot() { |
|
| 510 | - if (!self::$defaultInstance) { |
|
| 511 | - return null; |
|
| 512 | - } |
|
| 513 | - return self::$defaultInstance->getRoot(); |
|
| 514 | - } |
|
| 515 | - |
|
| 516 | - /** |
|
| 517 | - * clear all mounts and storage backends |
|
| 518 | - */ |
|
| 519 | - public static function clearMounts() { |
|
| 520 | - if (self::$mounts) { |
|
| 521 | - self::$usersSetup = array(); |
|
| 522 | - self::$mounts->clear(); |
|
| 523 | - } |
|
| 524 | - } |
|
| 525 | - |
|
| 526 | - /** |
|
| 527 | - * mount an \OC\Files\Storage\Storage in our virtual filesystem |
|
| 528 | - * |
|
| 529 | - * @param \OC\Files\Storage\Storage|string $class |
|
| 530 | - * @param array $arguments |
|
| 531 | - * @param string $mountpoint |
|
| 532 | - */ |
|
| 533 | - static public function mount($class, $arguments, $mountpoint) { |
|
| 534 | - if (!self::$mounts) { |
|
| 535 | - \OC_Util::setupFS(); |
|
| 536 | - } |
|
| 537 | - $mount = new Mount\MountPoint($class, $mountpoint, $arguments, self::getLoader()); |
|
| 538 | - self::$mounts->addMount($mount); |
|
| 539 | - } |
|
| 540 | - |
|
| 541 | - /** |
|
| 542 | - * return the path to a local version of the file |
|
| 543 | - * we need this because we can't know if a file is stored local or not from |
|
| 544 | - * outside the filestorage and for some purposes a local file is needed |
|
| 545 | - * |
|
| 546 | - * @param string $path |
|
| 547 | - * @return string |
|
| 548 | - */ |
|
| 549 | - static public function getLocalFile($path) { |
|
| 550 | - return self::$defaultInstance->getLocalFile($path); |
|
| 551 | - } |
|
| 552 | - |
|
| 553 | - /** |
|
| 554 | - * @param string $path |
|
| 555 | - * @return string |
|
| 556 | - */ |
|
| 557 | - static public function getLocalFolder($path) { |
|
| 558 | - return self::$defaultInstance->getLocalFolder($path); |
|
| 559 | - } |
|
| 560 | - |
|
| 561 | - /** |
|
| 562 | - * return path to file which reflects one visible in browser |
|
| 563 | - * |
|
| 564 | - * @param string $path |
|
| 565 | - * @return string |
|
| 566 | - */ |
|
| 567 | - static public function getLocalPath($path) { |
|
| 568 | - $datadir = \OC_User::getHome(\OC_User::getUser()) . '/files'; |
|
| 569 | - $newpath = $path; |
|
| 570 | - if (strncmp($newpath, $datadir, strlen($datadir)) == 0) { |
|
| 571 | - $newpath = substr($path, strlen($datadir)); |
|
| 572 | - } |
|
| 573 | - return $newpath; |
|
| 574 | - } |
|
| 575 | - |
|
| 576 | - /** |
|
| 577 | - * check if the requested path is valid |
|
| 578 | - * |
|
| 579 | - * @param string $path |
|
| 580 | - * @return bool |
|
| 581 | - */ |
|
| 582 | - static public function isValidPath($path) { |
|
| 583 | - $path = self::normalizePath($path); |
|
| 584 | - if (!$path || $path[0] !== '/') { |
|
| 585 | - $path = '/' . $path; |
|
| 586 | - } |
|
| 587 | - if (strpos($path, '/../') !== false || strrchr($path, '/') === '/..') { |
|
| 588 | - return false; |
|
| 589 | - } |
|
| 590 | - return true; |
|
| 591 | - } |
|
| 592 | - |
|
| 593 | - /** |
|
| 594 | - * checks if a file is blacklisted for storage in the filesystem |
|
| 595 | - * Listens to write and rename hooks |
|
| 596 | - * |
|
| 597 | - * @param array $data from hook |
|
| 598 | - */ |
|
| 599 | - static public function isBlacklisted($data) { |
|
| 600 | - if (isset($data['path'])) { |
|
| 601 | - $path = $data['path']; |
|
| 602 | - } else if (isset($data['newpath'])) { |
|
| 603 | - $path = $data['newpath']; |
|
| 604 | - } |
|
| 605 | - if (isset($path)) { |
|
| 606 | - if (self::isFileBlacklisted($path)) { |
|
| 607 | - $data['run'] = false; |
|
| 608 | - } |
|
| 609 | - } |
|
| 610 | - } |
|
| 611 | - |
|
| 612 | - /** |
|
| 613 | - * @param string $filename |
|
| 614 | - * @return bool |
|
| 615 | - */ |
|
| 616 | - static public function isFileBlacklisted($filename) { |
|
| 617 | - $filename = self::normalizePath($filename); |
|
| 618 | - |
|
| 619 | - $blacklist = \OC::$server->getConfig()->getSystemValue('blacklisted_files', array('.htaccess')); |
|
| 620 | - $filename = strtolower(basename($filename)); |
|
| 621 | - return in_array($filename, $blacklist); |
|
| 622 | - } |
|
| 623 | - |
|
| 624 | - /** |
|
| 625 | - * check if the directory should be ignored when scanning |
|
| 626 | - * NOTE: the special directories . and .. would cause never ending recursion |
|
| 627 | - * |
|
| 628 | - * @param String $dir |
|
| 629 | - * @return boolean |
|
| 630 | - */ |
|
| 631 | - static public function isIgnoredDir($dir) { |
|
| 632 | - if ($dir === '.' || $dir === '..') { |
|
| 633 | - return true; |
|
| 634 | - } |
|
| 635 | - return false; |
|
| 636 | - } |
|
| 637 | - |
|
| 638 | - /** |
|
| 639 | - * following functions are equivalent to their php builtin equivalents for arguments/return values. |
|
| 640 | - */ |
|
| 641 | - static public function mkdir($path) { |
|
| 642 | - return self::$defaultInstance->mkdir($path); |
|
| 643 | - } |
|
| 644 | - |
|
| 645 | - static public function rmdir($path) { |
|
| 646 | - return self::$defaultInstance->rmdir($path); |
|
| 647 | - } |
|
| 648 | - |
|
| 649 | - static public function is_dir($path) { |
|
| 650 | - return self::$defaultInstance->is_dir($path); |
|
| 651 | - } |
|
| 652 | - |
|
| 653 | - static public function is_file($path) { |
|
| 654 | - return self::$defaultInstance->is_file($path); |
|
| 655 | - } |
|
| 656 | - |
|
| 657 | - static public function stat($path) { |
|
| 658 | - return self::$defaultInstance->stat($path); |
|
| 659 | - } |
|
| 660 | - |
|
| 661 | - static public function filetype($path) { |
|
| 662 | - return self::$defaultInstance->filetype($path); |
|
| 663 | - } |
|
| 664 | - |
|
| 665 | - static public function filesize($path) { |
|
| 666 | - return self::$defaultInstance->filesize($path); |
|
| 667 | - } |
|
| 668 | - |
|
| 669 | - static public function readfile($path) { |
|
| 670 | - return self::$defaultInstance->readfile($path); |
|
| 671 | - } |
|
| 672 | - |
|
| 673 | - static public function isCreatable($path) { |
|
| 674 | - return self::$defaultInstance->isCreatable($path); |
|
| 675 | - } |
|
| 676 | - |
|
| 677 | - static public function isReadable($path) { |
|
| 678 | - return self::$defaultInstance->isReadable($path); |
|
| 679 | - } |
|
| 680 | - |
|
| 681 | - static public function isUpdatable($path) { |
|
| 682 | - return self::$defaultInstance->isUpdatable($path); |
|
| 683 | - } |
|
| 684 | - |
|
| 685 | - static public function isDeletable($path) { |
|
| 686 | - return self::$defaultInstance->isDeletable($path); |
|
| 687 | - } |
|
| 688 | - |
|
| 689 | - static public function isSharable($path) { |
|
| 690 | - return self::$defaultInstance->isSharable($path); |
|
| 691 | - } |
|
| 692 | - |
|
| 693 | - static public function file_exists($path) { |
|
| 694 | - return self::$defaultInstance->file_exists($path); |
|
| 695 | - } |
|
| 696 | - |
|
| 697 | - static public function filemtime($path) { |
|
| 698 | - return self::$defaultInstance->filemtime($path); |
|
| 699 | - } |
|
| 700 | - |
|
| 701 | - static public function touch($path, $mtime = null) { |
|
| 702 | - return self::$defaultInstance->touch($path, $mtime); |
|
| 703 | - } |
|
| 704 | - |
|
| 705 | - /** |
|
| 706 | - * @return string |
|
| 707 | - */ |
|
| 708 | - static public function file_get_contents($path) { |
|
| 709 | - return self::$defaultInstance->file_get_contents($path); |
|
| 710 | - } |
|
| 711 | - |
|
| 712 | - static public function file_put_contents($path, $data) { |
|
| 713 | - return self::$defaultInstance->file_put_contents($path, $data); |
|
| 714 | - } |
|
| 715 | - |
|
| 716 | - static public function unlink($path) { |
|
| 717 | - return self::$defaultInstance->unlink($path); |
|
| 718 | - } |
|
| 719 | - |
|
| 720 | - static public function rename($path1, $path2) { |
|
| 721 | - return self::$defaultInstance->rename($path1, $path2); |
|
| 722 | - } |
|
| 723 | - |
|
| 724 | - static public function copy($path1, $path2) { |
|
| 725 | - return self::$defaultInstance->copy($path1, $path2); |
|
| 726 | - } |
|
| 727 | - |
|
| 728 | - static public function fopen($path, $mode) { |
|
| 729 | - return self::$defaultInstance->fopen($path, $mode); |
|
| 730 | - } |
|
| 731 | - |
|
| 732 | - /** |
|
| 733 | - * @return string |
|
| 734 | - */ |
|
| 735 | - static public function toTmpFile($path) { |
|
| 736 | - return self::$defaultInstance->toTmpFile($path); |
|
| 737 | - } |
|
| 738 | - |
|
| 739 | - static public function fromTmpFile($tmpFile, $path) { |
|
| 740 | - return self::$defaultInstance->fromTmpFile($tmpFile, $path); |
|
| 741 | - } |
|
| 742 | - |
|
| 743 | - static public function getMimeType($path) { |
|
| 744 | - return self::$defaultInstance->getMimeType($path); |
|
| 745 | - } |
|
| 746 | - |
|
| 747 | - static public function hash($type, $path, $raw = false) { |
|
| 748 | - return self::$defaultInstance->hash($type, $path, $raw); |
|
| 749 | - } |
|
| 750 | - |
|
| 751 | - static public function free_space($path = '/') { |
|
| 752 | - return self::$defaultInstance->free_space($path); |
|
| 753 | - } |
|
| 754 | - |
|
| 755 | - static public function search($query) { |
|
| 756 | - return self::$defaultInstance->search($query); |
|
| 757 | - } |
|
| 758 | - |
|
| 759 | - /** |
|
| 760 | - * @param string $query |
|
| 761 | - */ |
|
| 762 | - static public function searchByMime($query) { |
|
| 763 | - return self::$defaultInstance->searchByMime($query); |
|
| 764 | - } |
|
| 765 | - |
|
| 766 | - /** |
|
| 767 | - * @param string|int $tag name or tag id |
|
| 768 | - * @param string $userId owner of the tags |
|
| 769 | - * @return FileInfo[] array or file info |
|
| 770 | - */ |
|
| 771 | - static public function searchByTag($tag, $userId) { |
|
| 772 | - return self::$defaultInstance->searchByTag($tag, $userId); |
|
| 773 | - } |
|
| 774 | - |
|
| 775 | - /** |
|
| 776 | - * check if a file or folder has been updated since $time |
|
| 777 | - * |
|
| 778 | - * @param string $path |
|
| 779 | - * @param int $time |
|
| 780 | - * @return bool |
|
| 781 | - */ |
|
| 782 | - static public function hasUpdated($path, $time) { |
|
| 783 | - return self::$defaultInstance->hasUpdated($path, $time); |
|
| 784 | - } |
|
| 785 | - |
|
| 786 | - /** |
|
| 787 | - * Fix common problems with a file path |
|
| 788 | - * |
|
| 789 | - * @param string $path |
|
| 790 | - * @param bool $stripTrailingSlash whether to strip the trailing slash |
|
| 791 | - * @param bool $isAbsolutePath whether the given path is absolute |
|
| 792 | - * @param bool $keepUnicode true to disable unicode normalization |
|
| 793 | - * @return string |
|
| 794 | - */ |
|
| 795 | - public static function normalizePath($path, $stripTrailingSlash = true, $isAbsolutePath = false, $keepUnicode = false) { |
|
| 796 | - if (is_null(self::$normalizedPathCache)) { |
|
| 797 | - self::$normalizedPathCache = new CappedMemoryCache(); |
|
| 798 | - } |
|
| 799 | - |
|
| 800 | - /** |
|
| 801 | - * FIXME: This is a workaround for existing classes and files which call |
|
| 802 | - * this function with another type than a valid string. This |
|
| 803 | - * conversion should get removed as soon as all existing |
|
| 804 | - * function calls have been fixed. |
|
| 805 | - */ |
|
| 806 | - $path = (string)$path; |
|
| 807 | - |
|
| 808 | - $cacheKey = json_encode([$path, $stripTrailingSlash, $isAbsolutePath, $keepUnicode]); |
|
| 809 | - |
|
| 810 | - if (isset(self::$normalizedPathCache[$cacheKey])) { |
|
| 811 | - return self::$normalizedPathCache[$cacheKey]; |
|
| 812 | - } |
|
| 813 | - |
|
| 814 | - if ($path == '') { |
|
| 815 | - return '/'; |
|
| 816 | - } |
|
| 817 | - |
|
| 818 | - //normalize unicode if possible |
|
| 819 | - if (!$keepUnicode) { |
|
| 820 | - $path = \OC_Util::normalizeUnicode($path); |
|
| 821 | - } |
|
| 822 | - |
|
| 823 | - //no windows style slashes |
|
| 824 | - $path = str_replace('\\', '/', $path); |
|
| 825 | - |
|
| 826 | - //add leading slash |
|
| 827 | - if ($path[0] !== '/') { |
|
| 828 | - $path = '/' . $path; |
|
| 829 | - } |
|
| 830 | - |
|
| 831 | - // remove '/./' |
|
| 832 | - // ugly, but str_replace() can't replace them all in one go |
|
| 833 | - // as the replacement itself is part of the search string |
|
| 834 | - // which will only be found during the next iteration |
|
| 835 | - while (strpos($path, '/./') !== false) { |
|
| 836 | - $path = str_replace('/./', '/', $path); |
|
| 837 | - } |
|
| 838 | - // remove sequences of slashes |
|
| 839 | - $path = preg_replace('#/{2,}#', '/', $path); |
|
| 840 | - |
|
| 841 | - //remove trailing slash |
|
| 842 | - if ($stripTrailingSlash and strlen($path) > 1 and substr($path, -1, 1) === '/') { |
|
| 843 | - $path = substr($path, 0, -1); |
|
| 844 | - } |
|
| 845 | - |
|
| 846 | - // remove trailing '/.' |
|
| 847 | - if (substr($path, -2) == '/.') { |
|
| 848 | - $path = substr($path, 0, -2); |
|
| 849 | - } |
|
| 850 | - |
|
| 851 | - $normalizedPath = $path; |
|
| 852 | - self::$normalizedPathCache[$cacheKey] = $normalizedPath; |
|
| 853 | - |
|
| 854 | - return $normalizedPath; |
|
| 855 | - } |
|
| 856 | - |
|
| 857 | - /** |
|
| 858 | - * get the filesystem info |
|
| 859 | - * |
|
| 860 | - * @param string $path |
|
| 861 | - * @param boolean $includeMountPoints whether to add mountpoint sizes, |
|
| 862 | - * defaults to true |
|
| 863 | - * @return \OC\Files\FileInfo|bool False if file does not exist |
|
| 864 | - */ |
|
| 865 | - public static function getFileInfo($path, $includeMountPoints = true) { |
|
| 866 | - return self::$defaultInstance->getFileInfo($path, $includeMountPoints); |
|
| 867 | - } |
|
| 868 | - |
|
| 869 | - /** |
|
| 870 | - * change file metadata |
|
| 871 | - * |
|
| 872 | - * @param string $path |
|
| 873 | - * @param array $data |
|
| 874 | - * @return int |
|
| 875 | - * |
|
| 876 | - * returns the fileid of the updated file |
|
| 877 | - */ |
|
| 878 | - public static function putFileInfo($path, $data) { |
|
| 879 | - return self::$defaultInstance->putFileInfo($path, $data); |
|
| 880 | - } |
|
| 881 | - |
|
| 882 | - /** |
|
| 883 | - * get the content of a directory |
|
| 884 | - * |
|
| 885 | - * @param string $directory path under datadirectory |
|
| 886 | - * @param string $mimetype_filter limit returned content to this mimetype or mimepart |
|
| 887 | - * @return \OC\Files\FileInfo[] |
|
| 888 | - */ |
|
| 889 | - public static function getDirectoryContent($directory, $mimetype_filter = '') { |
|
| 890 | - return self::$defaultInstance->getDirectoryContent($directory, $mimetype_filter); |
|
| 891 | - } |
|
| 892 | - |
|
| 893 | - /** |
|
| 894 | - * Get the path of a file by id |
|
| 895 | - * |
|
| 896 | - * Note that the resulting path is not guaranteed to be unique for the id, multiple paths can point to the same file |
|
| 897 | - * |
|
| 898 | - * @param int $id |
|
| 899 | - * @throws NotFoundException |
|
| 900 | - * @return string |
|
| 901 | - */ |
|
| 902 | - public static function getPath($id) { |
|
| 903 | - return self::$defaultInstance->getPath($id); |
|
| 904 | - } |
|
| 905 | - |
|
| 906 | - /** |
|
| 907 | - * Get the owner for a file or folder |
|
| 908 | - * |
|
| 909 | - * @param string $path |
|
| 910 | - * @return string |
|
| 911 | - */ |
|
| 912 | - public static function getOwner($path) { |
|
| 913 | - return self::$defaultInstance->getOwner($path); |
|
| 914 | - } |
|
| 915 | - |
|
| 916 | - /** |
|
| 917 | - * get the ETag for a file or folder |
|
| 918 | - * |
|
| 919 | - * @param string $path |
|
| 920 | - * @return string |
|
| 921 | - */ |
|
| 922 | - static public function getETag($path) { |
|
| 923 | - return self::$defaultInstance->getETag($path); |
|
| 924 | - } |
|
| 72 | + /** |
|
| 73 | + * @var Mount\Manager $mounts |
|
| 74 | + */ |
|
| 75 | + private static $mounts; |
|
| 76 | + |
|
| 77 | + public static $loaded = false; |
|
| 78 | + /** |
|
| 79 | + * @var \OC\Files\View $defaultInstance |
|
| 80 | + */ |
|
| 81 | + static private $defaultInstance; |
|
| 82 | + |
|
| 83 | + static private $usersSetup = array(); |
|
| 84 | + |
|
| 85 | + static private $normalizedPathCache = null; |
|
| 86 | + |
|
| 87 | + static private $listeningForProviders = false; |
|
| 88 | + |
|
| 89 | + /** |
|
| 90 | + * classname which used for hooks handling |
|
| 91 | + * used as signalclass in OC_Hooks::emit() |
|
| 92 | + */ |
|
| 93 | + const CLASSNAME = 'OC_Filesystem'; |
|
| 94 | + |
|
| 95 | + /** |
|
| 96 | + * signalname emitted before file renaming |
|
| 97 | + * |
|
| 98 | + * @param string $oldpath |
|
| 99 | + * @param string $newpath |
|
| 100 | + */ |
|
| 101 | + const signal_rename = 'rename'; |
|
| 102 | + |
|
| 103 | + /** |
|
| 104 | + * signal emitted after file renaming |
|
| 105 | + * |
|
| 106 | + * @param string $oldpath |
|
| 107 | + * @param string $newpath |
|
| 108 | + */ |
|
| 109 | + const signal_post_rename = 'post_rename'; |
|
| 110 | + |
|
| 111 | + /** |
|
| 112 | + * signal emitted before file/dir creation |
|
| 113 | + * |
|
| 114 | + * @param string $path |
|
| 115 | + * @param bool $run changing this flag to false in hook handler will cancel event |
|
| 116 | + */ |
|
| 117 | + const signal_create = 'create'; |
|
| 118 | + |
|
| 119 | + /** |
|
| 120 | + * signal emitted after file/dir creation |
|
| 121 | + * |
|
| 122 | + * @param string $path |
|
| 123 | + * @param bool $run changing this flag to false in hook handler will cancel event |
|
| 124 | + */ |
|
| 125 | + const signal_post_create = 'post_create'; |
|
| 126 | + |
|
| 127 | + /** |
|
| 128 | + * signal emits before file/dir copy |
|
| 129 | + * |
|
| 130 | + * @param string $oldpath |
|
| 131 | + * @param string $newpath |
|
| 132 | + * @param bool $run changing this flag to false in hook handler will cancel event |
|
| 133 | + */ |
|
| 134 | + const signal_copy = 'copy'; |
|
| 135 | + |
|
| 136 | + /** |
|
| 137 | + * signal emits after file/dir copy |
|
| 138 | + * |
|
| 139 | + * @param string $oldpath |
|
| 140 | + * @param string $newpath |
|
| 141 | + */ |
|
| 142 | + const signal_post_copy = 'post_copy'; |
|
| 143 | + |
|
| 144 | + /** |
|
| 145 | + * signal emits before file/dir save |
|
| 146 | + * |
|
| 147 | + * @param string $path |
|
| 148 | + * @param bool $run changing this flag to false in hook handler will cancel event |
|
| 149 | + */ |
|
| 150 | + const signal_write = 'write'; |
|
| 151 | + |
|
| 152 | + /** |
|
| 153 | + * signal emits after file/dir save |
|
| 154 | + * |
|
| 155 | + * @param string $path |
|
| 156 | + */ |
|
| 157 | + const signal_post_write = 'post_write'; |
|
| 158 | + |
|
| 159 | + /** |
|
| 160 | + * signal emitted before file/dir update |
|
| 161 | + * |
|
| 162 | + * @param string $path |
|
| 163 | + * @param bool $run changing this flag to false in hook handler will cancel event |
|
| 164 | + */ |
|
| 165 | + const signal_update = 'update'; |
|
| 166 | + |
|
| 167 | + /** |
|
| 168 | + * signal emitted after file/dir update |
|
| 169 | + * |
|
| 170 | + * @param string $path |
|
| 171 | + * @param bool $run changing this flag to false in hook handler will cancel event |
|
| 172 | + */ |
|
| 173 | + const signal_post_update = 'post_update'; |
|
| 174 | + |
|
| 175 | + /** |
|
| 176 | + * signal emits when reading file/dir |
|
| 177 | + * |
|
| 178 | + * @param string $path |
|
| 179 | + */ |
|
| 180 | + const signal_read = 'read'; |
|
| 181 | + |
|
| 182 | + /** |
|
| 183 | + * signal emits when removing file/dir |
|
| 184 | + * |
|
| 185 | + * @param string $path |
|
| 186 | + */ |
|
| 187 | + const signal_delete = 'delete'; |
|
| 188 | + |
|
| 189 | + /** |
|
| 190 | + * parameters definitions for signals |
|
| 191 | + */ |
|
| 192 | + const signal_param_path = 'path'; |
|
| 193 | + const signal_param_oldpath = 'oldpath'; |
|
| 194 | + const signal_param_newpath = 'newpath'; |
|
| 195 | + |
|
| 196 | + /** |
|
| 197 | + * run - changing this flag to false in hook handler will cancel event |
|
| 198 | + */ |
|
| 199 | + const signal_param_run = 'run'; |
|
| 200 | + |
|
| 201 | + const signal_create_mount = 'create_mount'; |
|
| 202 | + const signal_delete_mount = 'delete_mount'; |
|
| 203 | + const signal_param_mount_type = 'mounttype'; |
|
| 204 | + const signal_param_users = 'users'; |
|
| 205 | + |
|
| 206 | + /** |
|
| 207 | + * @var \OC\Files\Storage\StorageFactory $loader |
|
| 208 | + */ |
|
| 209 | + private static $loader; |
|
| 210 | + |
|
| 211 | + /** @var bool */ |
|
| 212 | + private static $logWarningWhenAddingStorageWrapper = true; |
|
| 213 | + |
|
| 214 | + /** |
|
| 215 | + * @param bool $shouldLog |
|
| 216 | + * @return bool previous value |
|
| 217 | + * @internal |
|
| 218 | + */ |
|
| 219 | + public static function logWarningWhenAddingStorageWrapper($shouldLog) { |
|
| 220 | + $previousValue = self::$logWarningWhenAddingStorageWrapper; |
|
| 221 | + self::$logWarningWhenAddingStorageWrapper = (bool) $shouldLog; |
|
| 222 | + return $previousValue; |
|
| 223 | + } |
|
| 224 | + |
|
| 225 | + /** |
|
| 226 | + * @param string $wrapperName |
|
| 227 | + * @param callable $wrapper |
|
| 228 | + * @param int $priority |
|
| 229 | + */ |
|
| 230 | + public static function addStorageWrapper($wrapperName, $wrapper, $priority = 50) { |
|
| 231 | + if (self::$logWarningWhenAddingStorageWrapper) { |
|
| 232 | + \OC::$server->getLogger()->warning("Storage wrapper '{wrapper}' was not registered via the 'OC_Filesystem - preSetup' hook which could cause potential problems.", [ |
|
| 233 | + 'wrapper' => $wrapperName, |
|
| 234 | + 'app' => 'filesystem', |
|
| 235 | + ]); |
|
| 236 | + } |
|
| 237 | + |
|
| 238 | + $mounts = self::getMountManager()->getAll(); |
|
| 239 | + if (!self::getLoader()->addStorageWrapper($wrapperName, $wrapper, $priority, $mounts)) { |
|
| 240 | + // do not re-wrap if storage with this name already existed |
|
| 241 | + return; |
|
| 242 | + } |
|
| 243 | + } |
|
| 244 | + |
|
| 245 | + /** |
|
| 246 | + * Returns the storage factory |
|
| 247 | + * |
|
| 248 | + * @return \OCP\Files\Storage\IStorageFactory |
|
| 249 | + */ |
|
| 250 | + public static function getLoader() { |
|
| 251 | + if (!self::$loader) { |
|
| 252 | + self::$loader = new StorageFactory(); |
|
| 253 | + } |
|
| 254 | + return self::$loader; |
|
| 255 | + } |
|
| 256 | + |
|
| 257 | + /** |
|
| 258 | + * Returns the mount manager |
|
| 259 | + * |
|
| 260 | + * @return \OC\Files\Mount\Manager |
|
| 261 | + */ |
|
| 262 | + public static function getMountManager($user = '') { |
|
| 263 | + if (!self::$mounts) { |
|
| 264 | + \OC_Util::setupFS($user); |
|
| 265 | + } |
|
| 266 | + return self::$mounts; |
|
| 267 | + } |
|
| 268 | + |
|
| 269 | + /** |
|
| 270 | + * get the mountpoint of the storage object for a path |
|
| 271 | + * ( note: because a storage is not always mounted inside the fakeroot, the |
|
| 272 | + * returned mountpoint is relative to the absolute root of the filesystem |
|
| 273 | + * and doesn't take the chroot into account ) |
|
| 274 | + * |
|
| 275 | + * @param string $path |
|
| 276 | + * @return string |
|
| 277 | + */ |
|
| 278 | + static public function getMountPoint($path) { |
|
| 279 | + if (!self::$mounts) { |
|
| 280 | + \OC_Util::setupFS(); |
|
| 281 | + } |
|
| 282 | + $mount = self::$mounts->find($path); |
|
| 283 | + if ($mount) { |
|
| 284 | + return $mount->getMountPoint(); |
|
| 285 | + } else { |
|
| 286 | + return ''; |
|
| 287 | + } |
|
| 288 | + } |
|
| 289 | + |
|
| 290 | + /** |
|
| 291 | + * get a list of all mount points in a directory |
|
| 292 | + * |
|
| 293 | + * @param string $path |
|
| 294 | + * @return string[] |
|
| 295 | + */ |
|
| 296 | + static public function getMountPoints($path) { |
|
| 297 | + if (!self::$mounts) { |
|
| 298 | + \OC_Util::setupFS(); |
|
| 299 | + } |
|
| 300 | + $result = array(); |
|
| 301 | + $mounts = self::$mounts->findIn($path); |
|
| 302 | + foreach ($mounts as $mount) { |
|
| 303 | + $result[] = $mount->getMountPoint(); |
|
| 304 | + } |
|
| 305 | + return $result; |
|
| 306 | + } |
|
| 307 | + |
|
| 308 | + /** |
|
| 309 | + * get the storage mounted at $mountPoint |
|
| 310 | + * |
|
| 311 | + * @param string $mountPoint |
|
| 312 | + * @return \OC\Files\Storage\Storage |
|
| 313 | + */ |
|
| 314 | + public static function getStorage($mountPoint) { |
|
| 315 | + if (!self::$mounts) { |
|
| 316 | + \OC_Util::setupFS(); |
|
| 317 | + } |
|
| 318 | + $mount = self::$mounts->find($mountPoint); |
|
| 319 | + return $mount->getStorage(); |
|
| 320 | + } |
|
| 321 | + |
|
| 322 | + /** |
|
| 323 | + * @param string $id |
|
| 324 | + * @return Mount\MountPoint[] |
|
| 325 | + */ |
|
| 326 | + public static function getMountByStorageId($id) { |
|
| 327 | + if (!self::$mounts) { |
|
| 328 | + \OC_Util::setupFS(); |
|
| 329 | + } |
|
| 330 | + return self::$mounts->findByStorageId($id); |
|
| 331 | + } |
|
| 332 | + |
|
| 333 | + /** |
|
| 334 | + * @param int $id |
|
| 335 | + * @return Mount\MountPoint[] |
|
| 336 | + */ |
|
| 337 | + public static function getMountByNumericId($id) { |
|
| 338 | + if (!self::$mounts) { |
|
| 339 | + \OC_Util::setupFS(); |
|
| 340 | + } |
|
| 341 | + return self::$mounts->findByNumericId($id); |
|
| 342 | + } |
|
| 343 | + |
|
| 344 | + /** |
|
| 345 | + * resolve a path to a storage and internal path |
|
| 346 | + * |
|
| 347 | + * @param string $path |
|
| 348 | + * @return array an array consisting of the storage and the internal path |
|
| 349 | + */ |
|
| 350 | + static public function resolvePath($path) { |
|
| 351 | + if (!self::$mounts) { |
|
| 352 | + \OC_Util::setupFS(); |
|
| 353 | + } |
|
| 354 | + $mount = self::$mounts->find($path); |
|
| 355 | + if ($mount) { |
|
| 356 | + return array($mount->getStorage(), rtrim($mount->getInternalPath($path), '/')); |
|
| 357 | + } else { |
|
| 358 | + return array(null, null); |
|
| 359 | + } |
|
| 360 | + } |
|
| 361 | + |
|
| 362 | + static public function init($user, $root) { |
|
| 363 | + if (self::$defaultInstance) { |
|
| 364 | + return false; |
|
| 365 | + } |
|
| 366 | + self::getLoader(); |
|
| 367 | + self::$defaultInstance = new View($root); |
|
| 368 | + |
|
| 369 | + if (!self::$mounts) { |
|
| 370 | + self::$mounts = \OC::$server->getMountManager(); |
|
| 371 | + } |
|
| 372 | + |
|
| 373 | + //load custom mount config |
|
| 374 | + self::initMountPoints($user); |
|
| 375 | + |
|
| 376 | + self::$loaded = true; |
|
| 377 | + |
|
| 378 | + return true; |
|
| 379 | + } |
|
| 380 | + |
|
| 381 | + static public function initMountManager() { |
|
| 382 | + if (!self::$mounts) { |
|
| 383 | + self::$mounts = \OC::$server->getMountManager(); |
|
| 384 | + } |
|
| 385 | + } |
|
| 386 | + |
|
| 387 | + /** |
|
| 388 | + * Initialize system and personal mount points for a user |
|
| 389 | + * |
|
| 390 | + * @param string $user |
|
| 391 | + * @throws \OC\User\NoUserException if the user is not available |
|
| 392 | + */ |
|
| 393 | + public static function initMountPoints($user = '') { |
|
| 394 | + if ($user == '') { |
|
| 395 | + $user = \OC_User::getUser(); |
|
| 396 | + } |
|
| 397 | + if ($user === null || $user === false || $user === '') { |
|
| 398 | + throw new \OC\User\NoUserException('Attempted to initialize mount points for null user and no user in session'); |
|
| 399 | + } |
|
| 400 | + |
|
| 401 | + if (isset(self::$usersSetup[$user])) { |
|
| 402 | + return; |
|
| 403 | + } |
|
| 404 | + |
|
| 405 | + self::$usersSetup[$user] = true; |
|
| 406 | + |
|
| 407 | + $userManager = \OC::$server->getUserManager(); |
|
| 408 | + $userObject = $userManager->get($user); |
|
| 409 | + |
|
| 410 | + if (is_null($userObject)) { |
|
| 411 | + \OCP\Util::writeLog('files', ' Backends provided no user object for ' . $user, \OCP\Util::ERROR); |
|
| 412 | + // reset flag, this will make it possible to rethrow the exception if called again |
|
| 413 | + unset(self::$usersSetup[$user]); |
|
| 414 | + throw new \OC\User\NoUserException('Backends provided no user object for ' . $user); |
|
| 415 | + } |
|
| 416 | + |
|
| 417 | + $realUid = $userObject->getUID(); |
|
| 418 | + // workaround in case of different casings |
|
| 419 | + if ($user !== $realUid) { |
|
| 420 | + $stack = json_encode(debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 50)); |
|
| 421 | + \OCP\Util::writeLog('files', 'initMountPoints() called with wrong user casing. This could be a bug. Expected: "' . $realUid . '" got "' . $user . '". Stack: ' . $stack, \OCP\Util::WARN); |
|
| 422 | + $user = $realUid; |
|
| 423 | + |
|
| 424 | + // again with the correct casing |
|
| 425 | + if (isset(self::$usersSetup[$user])) { |
|
| 426 | + return; |
|
| 427 | + } |
|
| 428 | + |
|
| 429 | + self::$usersSetup[$user] = true; |
|
| 430 | + } |
|
| 431 | + |
|
| 432 | + if (\OC::$server->getLockdownManager()->canAccessFilesystem()) { |
|
| 433 | + /** @var \OC\Files\Config\MountProviderCollection $mountConfigManager */ |
|
| 434 | + $mountConfigManager = \OC::$server->getMountProviderCollection(); |
|
| 435 | + |
|
| 436 | + // home mounts are handled seperate since we need to ensure this is mounted before we call the other mount providers |
|
| 437 | + $homeMount = $mountConfigManager->getHomeMountForUser($userObject); |
|
| 438 | + |
|
| 439 | + self::getMountManager()->addMount($homeMount); |
|
| 440 | + |
|
| 441 | + \OC\Files\Filesystem::getStorage($user); |
|
| 442 | + |
|
| 443 | + // Chance to mount for other storages |
|
| 444 | + if ($userObject) { |
|
| 445 | + $mounts = $mountConfigManager->addMountForUser($userObject, self::getMountManager()); |
|
| 446 | + $mounts[] = $homeMount; |
|
| 447 | + $mountConfigManager->registerMounts($userObject, $mounts); |
|
| 448 | + } |
|
| 449 | + |
|
| 450 | + self::listenForNewMountProviders($mountConfigManager, $userManager); |
|
| 451 | + } else { |
|
| 452 | + self::getMountManager()->addMount(new MountPoint( |
|
| 453 | + new NullStorage([]), |
|
| 454 | + '/' . $user |
|
| 455 | + )); |
|
| 456 | + self::getMountManager()->addMount(new MountPoint( |
|
| 457 | + new NullStorage([]), |
|
| 458 | + '/' . $user . '/files' |
|
| 459 | + )); |
|
| 460 | + } |
|
| 461 | + \OC_Hook::emit('OC_Filesystem', 'post_initMountPoints', array('user' => $user)); |
|
| 462 | + } |
|
| 463 | + |
|
| 464 | + /** |
|
| 465 | + * Get mounts from mount providers that are registered after setup |
|
| 466 | + * |
|
| 467 | + * @param MountProviderCollection $mountConfigManager |
|
| 468 | + * @param IUserManager $userManager |
|
| 469 | + */ |
|
| 470 | + private static function listenForNewMountProviders(MountProviderCollection $mountConfigManager, IUserManager $userManager) { |
|
| 471 | + if (!self::$listeningForProviders) { |
|
| 472 | + self::$listeningForProviders = true; |
|
| 473 | + $mountConfigManager->listen('\OC\Files\Config', 'registerMountProvider', function (IMountProvider $provider) use ($userManager) { |
|
| 474 | + foreach (Filesystem::$usersSetup as $user => $setup) { |
|
| 475 | + $userObject = $userManager->get($user); |
|
| 476 | + if ($userObject) { |
|
| 477 | + $mounts = $provider->getMountsForUser($userObject, Filesystem::getLoader()); |
|
| 478 | + array_walk($mounts, array(self::$mounts, 'addMount')); |
|
| 479 | + } |
|
| 480 | + } |
|
| 481 | + }); |
|
| 482 | + } |
|
| 483 | + } |
|
| 484 | + |
|
| 485 | + /** |
|
| 486 | + * get the default filesystem view |
|
| 487 | + * |
|
| 488 | + * @return View |
|
| 489 | + */ |
|
| 490 | + static public function getView() { |
|
| 491 | + return self::$defaultInstance; |
|
| 492 | + } |
|
| 493 | + |
|
| 494 | + /** |
|
| 495 | + * tear down the filesystem, removing all storage providers |
|
| 496 | + */ |
|
| 497 | + static public function tearDown() { |
|
| 498 | + self::clearMounts(); |
|
| 499 | + self::$defaultInstance = null; |
|
| 500 | + } |
|
| 501 | + |
|
| 502 | + /** |
|
| 503 | + * get the relative path of the root data directory for the current user |
|
| 504 | + * |
|
| 505 | + * @return string |
|
| 506 | + * |
|
| 507 | + * Returns path like /admin/files |
|
| 508 | + */ |
|
| 509 | + static public function getRoot() { |
|
| 510 | + if (!self::$defaultInstance) { |
|
| 511 | + return null; |
|
| 512 | + } |
|
| 513 | + return self::$defaultInstance->getRoot(); |
|
| 514 | + } |
|
| 515 | + |
|
| 516 | + /** |
|
| 517 | + * clear all mounts and storage backends |
|
| 518 | + */ |
|
| 519 | + public static function clearMounts() { |
|
| 520 | + if (self::$mounts) { |
|
| 521 | + self::$usersSetup = array(); |
|
| 522 | + self::$mounts->clear(); |
|
| 523 | + } |
|
| 524 | + } |
|
| 525 | + |
|
| 526 | + /** |
|
| 527 | + * mount an \OC\Files\Storage\Storage in our virtual filesystem |
|
| 528 | + * |
|
| 529 | + * @param \OC\Files\Storage\Storage|string $class |
|
| 530 | + * @param array $arguments |
|
| 531 | + * @param string $mountpoint |
|
| 532 | + */ |
|
| 533 | + static public function mount($class, $arguments, $mountpoint) { |
|
| 534 | + if (!self::$mounts) { |
|
| 535 | + \OC_Util::setupFS(); |
|
| 536 | + } |
|
| 537 | + $mount = new Mount\MountPoint($class, $mountpoint, $arguments, self::getLoader()); |
|
| 538 | + self::$mounts->addMount($mount); |
|
| 539 | + } |
|
| 540 | + |
|
| 541 | + /** |
|
| 542 | + * return the path to a local version of the file |
|
| 543 | + * we need this because we can't know if a file is stored local or not from |
|
| 544 | + * outside the filestorage and for some purposes a local file is needed |
|
| 545 | + * |
|
| 546 | + * @param string $path |
|
| 547 | + * @return string |
|
| 548 | + */ |
|
| 549 | + static public function getLocalFile($path) { |
|
| 550 | + return self::$defaultInstance->getLocalFile($path); |
|
| 551 | + } |
|
| 552 | + |
|
| 553 | + /** |
|
| 554 | + * @param string $path |
|
| 555 | + * @return string |
|
| 556 | + */ |
|
| 557 | + static public function getLocalFolder($path) { |
|
| 558 | + return self::$defaultInstance->getLocalFolder($path); |
|
| 559 | + } |
|
| 560 | + |
|
| 561 | + /** |
|
| 562 | + * return path to file which reflects one visible in browser |
|
| 563 | + * |
|
| 564 | + * @param string $path |
|
| 565 | + * @return string |
|
| 566 | + */ |
|
| 567 | + static public function getLocalPath($path) { |
|
| 568 | + $datadir = \OC_User::getHome(\OC_User::getUser()) . '/files'; |
|
| 569 | + $newpath = $path; |
|
| 570 | + if (strncmp($newpath, $datadir, strlen($datadir)) == 0) { |
|
| 571 | + $newpath = substr($path, strlen($datadir)); |
|
| 572 | + } |
|
| 573 | + return $newpath; |
|
| 574 | + } |
|
| 575 | + |
|
| 576 | + /** |
|
| 577 | + * check if the requested path is valid |
|
| 578 | + * |
|
| 579 | + * @param string $path |
|
| 580 | + * @return bool |
|
| 581 | + */ |
|
| 582 | + static public function isValidPath($path) { |
|
| 583 | + $path = self::normalizePath($path); |
|
| 584 | + if (!$path || $path[0] !== '/') { |
|
| 585 | + $path = '/' . $path; |
|
| 586 | + } |
|
| 587 | + if (strpos($path, '/../') !== false || strrchr($path, '/') === '/..') { |
|
| 588 | + return false; |
|
| 589 | + } |
|
| 590 | + return true; |
|
| 591 | + } |
|
| 592 | + |
|
| 593 | + /** |
|
| 594 | + * checks if a file is blacklisted for storage in the filesystem |
|
| 595 | + * Listens to write and rename hooks |
|
| 596 | + * |
|
| 597 | + * @param array $data from hook |
|
| 598 | + */ |
|
| 599 | + static public function isBlacklisted($data) { |
|
| 600 | + if (isset($data['path'])) { |
|
| 601 | + $path = $data['path']; |
|
| 602 | + } else if (isset($data['newpath'])) { |
|
| 603 | + $path = $data['newpath']; |
|
| 604 | + } |
|
| 605 | + if (isset($path)) { |
|
| 606 | + if (self::isFileBlacklisted($path)) { |
|
| 607 | + $data['run'] = false; |
|
| 608 | + } |
|
| 609 | + } |
|
| 610 | + } |
|
| 611 | + |
|
| 612 | + /** |
|
| 613 | + * @param string $filename |
|
| 614 | + * @return bool |
|
| 615 | + */ |
|
| 616 | + static public function isFileBlacklisted($filename) { |
|
| 617 | + $filename = self::normalizePath($filename); |
|
| 618 | + |
|
| 619 | + $blacklist = \OC::$server->getConfig()->getSystemValue('blacklisted_files', array('.htaccess')); |
|
| 620 | + $filename = strtolower(basename($filename)); |
|
| 621 | + return in_array($filename, $blacklist); |
|
| 622 | + } |
|
| 623 | + |
|
| 624 | + /** |
|
| 625 | + * check if the directory should be ignored when scanning |
|
| 626 | + * NOTE: the special directories . and .. would cause never ending recursion |
|
| 627 | + * |
|
| 628 | + * @param String $dir |
|
| 629 | + * @return boolean |
|
| 630 | + */ |
|
| 631 | + static public function isIgnoredDir($dir) { |
|
| 632 | + if ($dir === '.' || $dir === '..') { |
|
| 633 | + return true; |
|
| 634 | + } |
|
| 635 | + return false; |
|
| 636 | + } |
|
| 637 | + |
|
| 638 | + /** |
|
| 639 | + * following functions are equivalent to their php builtin equivalents for arguments/return values. |
|
| 640 | + */ |
|
| 641 | + static public function mkdir($path) { |
|
| 642 | + return self::$defaultInstance->mkdir($path); |
|
| 643 | + } |
|
| 644 | + |
|
| 645 | + static public function rmdir($path) { |
|
| 646 | + return self::$defaultInstance->rmdir($path); |
|
| 647 | + } |
|
| 648 | + |
|
| 649 | + static public function is_dir($path) { |
|
| 650 | + return self::$defaultInstance->is_dir($path); |
|
| 651 | + } |
|
| 652 | + |
|
| 653 | + static public function is_file($path) { |
|
| 654 | + return self::$defaultInstance->is_file($path); |
|
| 655 | + } |
|
| 656 | + |
|
| 657 | + static public function stat($path) { |
|
| 658 | + return self::$defaultInstance->stat($path); |
|
| 659 | + } |
|
| 660 | + |
|
| 661 | + static public function filetype($path) { |
|
| 662 | + return self::$defaultInstance->filetype($path); |
|
| 663 | + } |
|
| 664 | + |
|
| 665 | + static public function filesize($path) { |
|
| 666 | + return self::$defaultInstance->filesize($path); |
|
| 667 | + } |
|
| 668 | + |
|
| 669 | + static public function readfile($path) { |
|
| 670 | + return self::$defaultInstance->readfile($path); |
|
| 671 | + } |
|
| 672 | + |
|
| 673 | + static public function isCreatable($path) { |
|
| 674 | + return self::$defaultInstance->isCreatable($path); |
|
| 675 | + } |
|
| 676 | + |
|
| 677 | + static public function isReadable($path) { |
|
| 678 | + return self::$defaultInstance->isReadable($path); |
|
| 679 | + } |
|
| 680 | + |
|
| 681 | + static public function isUpdatable($path) { |
|
| 682 | + return self::$defaultInstance->isUpdatable($path); |
|
| 683 | + } |
|
| 684 | + |
|
| 685 | + static public function isDeletable($path) { |
|
| 686 | + return self::$defaultInstance->isDeletable($path); |
|
| 687 | + } |
|
| 688 | + |
|
| 689 | + static public function isSharable($path) { |
|
| 690 | + return self::$defaultInstance->isSharable($path); |
|
| 691 | + } |
|
| 692 | + |
|
| 693 | + static public function file_exists($path) { |
|
| 694 | + return self::$defaultInstance->file_exists($path); |
|
| 695 | + } |
|
| 696 | + |
|
| 697 | + static public function filemtime($path) { |
|
| 698 | + return self::$defaultInstance->filemtime($path); |
|
| 699 | + } |
|
| 700 | + |
|
| 701 | + static public function touch($path, $mtime = null) { |
|
| 702 | + return self::$defaultInstance->touch($path, $mtime); |
|
| 703 | + } |
|
| 704 | + |
|
| 705 | + /** |
|
| 706 | + * @return string |
|
| 707 | + */ |
|
| 708 | + static public function file_get_contents($path) { |
|
| 709 | + return self::$defaultInstance->file_get_contents($path); |
|
| 710 | + } |
|
| 711 | + |
|
| 712 | + static public function file_put_contents($path, $data) { |
|
| 713 | + return self::$defaultInstance->file_put_contents($path, $data); |
|
| 714 | + } |
|
| 715 | + |
|
| 716 | + static public function unlink($path) { |
|
| 717 | + return self::$defaultInstance->unlink($path); |
|
| 718 | + } |
|
| 719 | + |
|
| 720 | + static public function rename($path1, $path2) { |
|
| 721 | + return self::$defaultInstance->rename($path1, $path2); |
|
| 722 | + } |
|
| 723 | + |
|
| 724 | + static public function copy($path1, $path2) { |
|
| 725 | + return self::$defaultInstance->copy($path1, $path2); |
|
| 726 | + } |
|
| 727 | + |
|
| 728 | + static public function fopen($path, $mode) { |
|
| 729 | + return self::$defaultInstance->fopen($path, $mode); |
|
| 730 | + } |
|
| 731 | + |
|
| 732 | + /** |
|
| 733 | + * @return string |
|
| 734 | + */ |
|
| 735 | + static public function toTmpFile($path) { |
|
| 736 | + return self::$defaultInstance->toTmpFile($path); |
|
| 737 | + } |
|
| 738 | + |
|
| 739 | + static public function fromTmpFile($tmpFile, $path) { |
|
| 740 | + return self::$defaultInstance->fromTmpFile($tmpFile, $path); |
|
| 741 | + } |
|
| 742 | + |
|
| 743 | + static public function getMimeType($path) { |
|
| 744 | + return self::$defaultInstance->getMimeType($path); |
|
| 745 | + } |
|
| 746 | + |
|
| 747 | + static public function hash($type, $path, $raw = false) { |
|
| 748 | + return self::$defaultInstance->hash($type, $path, $raw); |
|
| 749 | + } |
|
| 750 | + |
|
| 751 | + static public function free_space($path = '/') { |
|
| 752 | + return self::$defaultInstance->free_space($path); |
|
| 753 | + } |
|
| 754 | + |
|
| 755 | + static public function search($query) { |
|
| 756 | + return self::$defaultInstance->search($query); |
|
| 757 | + } |
|
| 758 | + |
|
| 759 | + /** |
|
| 760 | + * @param string $query |
|
| 761 | + */ |
|
| 762 | + static public function searchByMime($query) { |
|
| 763 | + return self::$defaultInstance->searchByMime($query); |
|
| 764 | + } |
|
| 765 | + |
|
| 766 | + /** |
|
| 767 | + * @param string|int $tag name or tag id |
|
| 768 | + * @param string $userId owner of the tags |
|
| 769 | + * @return FileInfo[] array or file info |
|
| 770 | + */ |
|
| 771 | + static public function searchByTag($tag, $userId) { |
|
| 772 | + return self::$defaultInstance->searchByTag($tag, $userId); |
|
| 773 | + } |
|
| 774 | + |
|
| 775 | + /** |
|
| 776 | + * check if a file or folder has been updated since $time |
|
| 777 | + * |
|
| 778 | + * @param string $path |
|
| 779 | + * @param int $time |
|
| 780 | + * @return bool |
|
| 781 | + */ |
|
| 782 | + static public function hasUpdated($path, $time) { |
|
| 783 | + return self::$defaultInstance->hasUpdated($path, $time); |
|
| 784 | + } |
|
| 785 | + |
|
| 786 | + /** |
|
| 787 | + * Fix common problems with a file path |
|
| 788 | + * |
|
| 789 | + * @param string $path |
|
| 790 | + * @param bool $stripTrailingSlash whether to strip the trailing slash |
|
| 791 | + * @param bool $isAbsolutePath whether the given path is absolute |
|
| 792 | + * @param bool $keepUnicode true to disable unicode normalization |
|
| 793 | + * @return string |
|
| 794 | + */ |
|
| 795 | + public static function normalizePath($path, $stripTrailingSlash = true, $isAbsolutePath = false, $keepUnicode = false) { |
|
| 796 | + if (is_null(self::$normalizedPathCache)) { |
|
| 797 | + self::$normalizedPathCache = new CappedMemoryCache(); |
|
| 798 | + } |
|
| 799 | + |
|
| 800 | + /** |
|
| 801 | + * FIXME: This is a workaround for existing classes and files which call |
|
| 802 | + * this function with another type than a valid string. This |
|
| 803 | + * conversion should get removed as soon as all existing |
|
| 804 | + * function calls have been fixed. |
|
| 805 | + */ |
|
| 806 | + $path = (string)$path; |
|
| 807 | + |
|
| 808 | + $cacheKey = json_encode([$path, $stripTrailingSlash, $isAbsolutePath, $keepUnicode]); |
|
| 809 | + |
|
| 810 | + if (isset(self::$normalizedPathCache[$cacheKey])) { |
|
| 811 | + return self::$normalizedPathCache[$cacheKey]; |
|
| 812 | + } |
|
| 813 | + |
|
| 814 | + if ($path == '') { |
|
| 815 | + return '/'; |
|
| 816 | + } |
|
| 817 | + |
|
| 818 | + //normalize unicode if possible |
|
| 819 | + if (!$keepUnicode) { |
|
| 820 | + $path = \OC_Util::normalizeUnicode($path); |
|
| 821 | + } |
|
| 822 | + |
|
| 823 | + //no windows style slashes |
|
| 824 | + $path = str_replace('\\', '/', $path); |
|
| 825 | + |
|
| 826 | + //add leading slash |
|
| 827 | + if ($path[0] !== '/') { |
|
| 828 | + $path = '/' . $path; |
|
| 829 | + } |
|
| 830 | + |
|
| 831 | + // remove '/./' |
|
| 832 | + // ugly, but str_replace() can't replace them all in one go |
|
| 833 | + // as the replacement itself is part of the search string |
|
| 834 | + // which will only be found during the next iteration |
|
| 835 | + while (strpos($path, '/./') !== false) { |
|
| 836 | + $path = str_replace('/./', '/', $path); |
|
| 837 | + } |
|
| 838 | + // remove sequences of slashes |
|
| 839 | + $path = preg_replace('#/{2,}#', '/', $path); |
|
| 840 | + |
|
| 841 | + //remove trailing slash |
|
| 842 | + if ($stripTrailingSlash and strlen($path) > 1 and substr($path, -1, 1) === '/') { |
|
| 843 | + $path = substr($path, 0, -1); |
|
| 844 | + } |
|
| 845 | + |
|
| 846 | + // remove trailing '/.' |
|
| 847 | + if (substr($path, -2) == '/.') { |
|
| 848 | + $path = substr($path, 0, -2); |
|
| 849 | + } |
|
| 850 | + |
|
| 851 | + $normalizedPath = $path; |
|
| 852 | + self::$normalizedPathCache[$cacheKey] = $normalizedPath; |
|
| 853 | + |
|
| 854 | + return $normalizedPath; |
|
| 855 | + } |
|
| 856 | + |
|
| 857 | + /** |
|
| 858 | + * get the filesystem info |
|
| 859 | + * |
|
| 860 | + * @param string $path |
|
| 861 | + * @param boolean $includeMountPoints whether to add mountpoint sizes, |
|
| 862 | + * defaults to true |
|
| 863 | + * @return \OC\Files\FileInfo|bool False if file does not exist |
|
| 864 | + */ |
|
| 865 | + public static function getFileInfo($path, $includeMountPoints = true) { |
|
| 866 | + return self::$defaultInstance->getFileInfo($path, $includeMountPoints); |
|
| 867 | + } |
|
| 868 | + |
|
| 869 | + /** |
|
| 870 | + * change file metadata |
|
| 871 | + * |
|
| 872 | + * @param string $path |
|
| 873 | + * @param array $data |
|
| 874 | + * @return int |
|
| 875 | + * |
|
| 876 | + * returns the fileid of the updated file |
|
| 877 | + */ |
|
| 878 | + public static function putFileInfo($path, $data) { |
|
| 879 | + return self::$defaultInstance->putFileInfo($path, $data); |
|
| 880 | + } |
|
| 881 | + |
|
| 882 | + /** |
|
| 883 | + * get the content of a directory |
|
| 884 | + * |
|
| 885 | + * @param string $directory path under datadirectory |
|
| 886 | + * @param string $mimetype_filter limit returned content to this mimetype or mimepart |
|
| 887 | + * @return \OC\Files\FileInfo[] |
|
| 888 | + */ |
|
| 889 | + public static function getDirectoryContent($directory, $mimetype_filter = '') { |
|
| 890 | + return self::$defaultInstance->getDirectoryContent($directory, $mimetype_filter); |
|
| 891 | + } |
|
| 892 | + |
|
| 893 | + /** |
|
| 894 | + * Get the path of a file by id |
|
| 895 | + * |
|
| 896 | + * Note that the resulting path is not guaranteed to be unique for the id, multiple paths can point to the same file |
|
| 897 | + * |
|
| 898 | + * @param int $id |
|
| 899 | + * @throws NotFoundException |
|
| 900 | + * @return string |
|
| 901 | + */ |
|
| 902 | + public static function getPath($id) { |
|
| 903 | + return self::$defaultInstance->getPath($id); |
|
| 904 | + } |
|
| 905 | + |
|
| 906 | + /** |
|
| 907 | + * Get the owner for a file or folder |
|
| 908 | + * |
|
| 909 | + * @param string $path |
|
| 910 | + * @return string |
|
| 911 | + */ |
|
| 912 | + public static function getOwner($path) { |
|
| 913 | + return self::$defaultInstance->getOwner($path); |
|
| 914 | + } |
|
| 915 | + |
|
| 916 | + /** |
|
| 917 | + * get the ETag for a file or folder |
|
| 918 | + * |
|
| 919 | + * @param string $path |
|
| 920 | + * @return string |
|
| 921 | + */ |
|
| 922 | + static public function getETag($path) { |
|
| 923 | + return self::$defaultInstance->getETag($path); |
|
| 924 | + } |
|
| 925 | 925 | } |
@@ -984,7 +984,7 @@ discard block |
||
| 984 | 984 | /** |
| 985 | 985 | * check if path points to a files version |
| 986 | 986 | * |
| 987 | - * @param $path |
|
| 987 | + * @param string $path |
|
| 988 | 988 | * @return bool |
| 989 | 989 | */ |
| 990 | 990 | protected function isVersion($path) { |
@@ -995,7 +995,7 @@ discard block |
||
| 995 | 995 | /** |
| 996 | 996 | * check if the given storage should be encrypted or not |
| 997 | 997 | * |
| 998 | - * @param $path |
|
| 998 | + * @param string $path |
|
| 999 | 999 | * @return bool |
| 1000 | 1000 | */ |
| 1001 | 1001 | protected function shouldEncrypt($path) { |
@@ -46,979 +46,979 @@ |
||
| 46 | 46 | |
| 47 | 47 | class Encryption extends Wrapper { |
| 48 | 48 | |
| 49 | - use LocalTempFileTrait; |
|
| 50 | - |
|
| 51 | - /** @var string */ |
|
| 52 | - private $mountPoint; |
|
| 53 | - |
|
| 54 | - /** @var \OC\Encryption\Util */ |
|
| 55 | - private $util; |
|
| 56 | - |
|
| 57 | - /** @var \OCP\Encryption\IManager */ |
|
| 58 | - private $encryptionManager; |
|
| 59 | - |
|
| 60 | - /** @var \OCP\ILogger */ |
|
| 61 | - private $logger; |
|
| 62 | - |
|
| 63 | - /** @var string */ |
|
| 64 | - private $uid; |
|
| 65 | - |
|
| 66 | - /** @var array */ |
|
| 67 | - protected $unencryptedSize; |
|
| 68 | - |
|
| 69 | - /** @var \OCP\Encryption\IFile */ |
|
| 70 | - private $fileHelper; |
|
| 71 | - |
|
| 72 | - /** @var IMountPoint */ |
|
| 73 | - private $mount; |
|
| 74 | - |
|
| 75 | - /** @var IStorage */ |
|
| 76 | - private $keyStorage; |
|
| 77 | - |
|
| 78 | - /** @var Update */ |
|
| 79 | - private $update; |
|
| 80 | - |
|
| 81 | - /** @var Manager */ |
|
| 82 | - private $mountManager; |
|
| 83 | - |
|
| 84 | - /** @var array remember for which path we execute the repair step to avoid recursions */ |
|
| 85 | - private $fixUnencryptedSizeOf = array(); |
|
| 86 | - |
|
| 87 | - /** @var ArrayCache */ |
|
| 88 | - private $arrayCache; |
|
| 89 | - |
|
| 90 | - /** |
|
| 91 | - * @param array $parameters |
|
| 92 | - * @param IManager $encryptionManager |
|
| 93 | - * @param Util $util |
|
| 94 | - * @param ILogger $logger |
|
| 95 | - * @param IFile $fileHelper |
|
| 96 | - * @param string $uid |
|
| 97 | - * @param IStorage $keyStorage |
|
| 98 | - * @param Update $update |
|
| 99 | - * @param Manager $mountManager |
|
| 100 | - * @param ArrayCache $arrayCache |
|
| 101 | - */ |
|
| 102 | - public function __construct( |
|
| 103 | - $parameters, |
|
| 104 | - IManager $encryptionManager = null, |
|
| 105 | - Util $util = null, |
|
| 106 | - ILogger $logger = null, |
|
| 107 | - IFile $fileHelper = null, |
|
| 108 | - $uid = null, |
|
| 109 | - IStorage $keyStorage = null, |
|
| 110 | - Update $update = null, |
|
| 111 | - Manager $mountManager = null, |
|
| 112 | - ArrayCache $arrayCache = null |
|
| 113 | - ) { |
|
| 114 | - |
|
| 115 | - $this->mountPoint = $parameters['mountPoint']; |
|
| 116 | - $this->mount = $parameters['mount']; |
|
| 117 | - $this->encryptionManager = $encryptionManager; |
|
| 118 | - $this->util = $util; |
|
| 119 | - $this->logger = $logger; |
|
| 120 | - $this->uid = $uid; |
|
| 121 | - $this->fileHelper = $fileHelper; |
|
| 122 | - $this->keyStorage = $keyStorage; |
|
| 123 | - $this->unencryptedSize = array(); |
|
| 124 | - $this->update = $update; |
|
| 125 | - $this->mountManager = $mountManager; |
|
| 126 | - $this->arrayCache = $arrayCache; |
|
| 127 | - parent::__construct($parameters); |
|
| 128 | - } |
|
| 129 | - |
|
| 130 | - /** |
|
| 131 | - * see http://php.net/manual/en/function.filesize.php |
|
| 132 | - * The result for filesize when called on a folder is required to be 0 |
|
| 133 | - * |
|
| 134 | - * @param string $path |
|
| 135 | - * @return int |
|
| 136 | - */ |
|
| 137 | - public function filesize($path) { |
|
| 138 | - $fullPath = $this->getFullPath($path); |
|
| 139 | - |
|
| 140 | - /** @var CacheEntry $info */ |
|
| 141 | - $info = $this->getCache()->get($path); |
|
| 142 | - if (isset($this->unencryptedSize[$fullPath])) { |
|
| 143 | - $size = $this->unencryptedSize[$fullPath]; |
|
| 144 | - // update file cache |
|
| 145 | - if ($info instanceof ICacheEntry) { |
|
| 146 | - $info = $info->getData(); |
|
| 147 | - $info['encrypted'] = $info['encryptedVersion']; |
|
| 148 | - } else { |
|
| 149 | - if (!is_array($info)) { |
|
| 150 | - $info = []; |
|
| 151 | - } |
|
| 152 | - $info['encrypted'] = true; |
|
| 153 | - } |
|
| 154 | - |
|
| 155 | - $info['size'] = $size; |
|
| 156 | - $this->getCache()->put($path, $info); |
|
| 157 | - |
|
| 158 | - return $size; |
|
| 159 | - } |
|
| 160 | - |
|
| 161 | - if (isset($info['fileid']) && $info['encrypted']) { |
|
| 162 | - return $this->verifyUnencryptedSize($path, $info['size']); |
|
| 163 | - } |
|
| 164 | - |
|
| 165 | - return $this->storage->filesize($path); |
|
| 166 | - } |
|
| 167 | - |
|
| 168 | - /** |
|
| 169 | - * @param string $path |
|
| 170 | - * @return array |
|
| 171 | - */ |
|
| 172 | - public function getMetaData($path) { |
|
| 173 | - $data = $this->storage->getMetaData($path); |
|
| 174 | - if (is_null($data)) { |
|
| 175 | - return null; |
|
| 176 | - } |
|
| 177 | - $fullPath = $this->getFullPath($path); |
|
| 178 | - $info = $this->getCache()->get($path); |
|
| 179 | - |
|
| 180 | - if (isset($this->unencryptedSize[$fullPath])) { |
|
| 181 | - $data['encrypted'] = true; |
|
| 182 | - $data['size'] = $this->unencryptedSize[$fullPath]; |
|
| 183 | - } else { |
|
| 184 | - if (isset($info['fileid']) && $info['encrypted']) { |
|
| 185 | - $data['size'] = $this->verifyUnencryptedSize($path, $info['size']); |
|
| 186 | - $data['encrypted'] = true; |
|
| 187 | - } |
|
| 188 | - } |
|
| 189 | - |
|
| 190 | - if (isset($info['encryptedVersion']) && $info['encryptedVersion'] > 1) { |
|
| 191 | - $data['encryptedVersion'] = $info['encryptedVersion']; |
|
| 192 | - } |
|
| 193 | - |
|
| 194 | - return $data; |
|
| 195 | - } |
|
| 196 | - |
|
| 197 | - /** |
|
| 198 | - * see http://php.net/manual/en/function.file_get_contents.php |
|
| 199 | - * |
|
| 200 | - * @param string $path |
|
| 201 | - * @return string |
|
| 202 | - */ |
|
| 203 | - public function file_get_contents($path) { |
|
| 204 | - |
|
| 205 | - $encryptionModule = $this->getEncryptionModule($path); |
|
| 206 | - |
|
| 207 | - if ($encryptionModule) { |
|
| 208 | - $handle = $this->fopen($path, "r"); |
|
| 209 | - if (!$handle) { |
|
| 210 | - return false; |
|
| 211 | - } |
|
| 212 | - $data = stream_get_contents($handle); |
|
| 213 | - fclose($handle); |
|
| 214 | - return $data; |
|
| 215 | - } |
|
| 216 | - return $this->storage->file_get_contents($path); |
|
| 217 | - } |
|
| 218 | - |
|
| 219 | - /** |
|
| 220 | - * see http://php.net/manual/en/function.file_put_contents.php |
|
| 221 | - * |
|
| 222 | - * @param string $path |
|
| 223 | - * @param string $data |
|
| 224 | - * @return bool |
|
| 225 | - */ |
|
| 226 | - public function file_put_contents($path, $data) { |
|
| 227 | - // file put content will always be translated to a stream write |
|
| 228 | - $handle = $this->fopen($path, 'w'); |
|
| 229 | - if (is_resource($handle)) { |
|
| 230 | - $written = fwrite($handle, $data); |
|
| 231 | - fclose($handle); |
|
| 232 | - return $written; |
|
| 233 | - } |
|
| 234 | - |
|
| 235 | - return false; |
|
| 236 | - } |
|
| 237 | - |
|
| 238 | - /** |
|
| 239 | - * see http://php.net/manual/en/function.unlink.php |
|
| 240 | - * |
|
| 241 | - * @param string $path |
|
| 242 | - * @return bool |
|
| 243 | - */ |
|
| 244 | - public function unlink($path) { |
|
| 245 | - $fullPath = $this->getFullPath($path); |
|
| 246 | - if ($this->util->isExcluded($fullPath)) { |
|
| 247 | - return $this->storage->unlink($path); |
|
| 248 | - } |
|
| 249 | - |
|
| 250 | - $encryptionModule = $this->getEncryptionModule($path); |
|
| 251 | - if ($encryptionModule) { |
|
| 252 | - $this->keyStorage->deleteAllFileKeys($this->getFullPath($path)); |
|
| 253 | - } |
|
| 254 | - |
|
| 255 | - return $this->storage->unlink($path); |
|
| 256 | - } |
|
| 257 | - |
|
| 258 | - /** |
|
| 259 | - * see http://php.net/manual/en/function.rename.php |
|
| 260 | - * |
|
| 261 | - * @param string $path1 |
|
| 262 | - * @param string $path2 |
|
| 263 | - * @return bool |
|
| 264 | - */ |
|
| 265 | - public function rename($path1, $path2) { |
|
| 266 | - |
|
| 267 | - $result = $this->storage->rename($path1, $path2); |
|
| 268 | - |
|
| 269 | - if ($result && |
|
| 270 | - // versions always use the keys from the original file, so we can skip |
|
| 271 | - // this step for versions |
|
| 272 | - $this->isVersion($path2) === false && |
|
| 273 | - $this->encryptionManager->isEnabled()) { |
|
| 274 | - $source = $this->getFullPath($path1); |
|
| 275 | - if (!$this->util->isExcluded($source)) { |
|
| 276 | - $target = $this->getFullPath($path2); |
|
| 277 | - if (isset($this->unencryptedSize[$source])) { |
|
| 278 | - $this->unencryptedSize[$target] = $this->unencryptedSize[$source]; |
|
| 279 | - } |
|
| 280 | - $this->keyStorage->renameKeys($source, $target); |
|
| 281 | - $module = $this->getEncryptionModule($path2); |
|
| 282 | - if ($module) { |
|
| 283 | - $module->update($target, $this->uid, []); |
|
| 284 | - } |
|
| 285 | - } |
|
| 286 | - } |
|
| 287 | - |
|
| 288 | - return $result; |
|
| 289 | - } |
|
| 290 | - |
|
| 291 | - /** |
|
| 292 | - * see http://php.net/manual/en/function.rmdir.php |
|
| 293 | - * |
|
| 294 | - * @param string $path |
|
| 295 | - * @return bool |
|
| 296 | - */ |
|
| 297 | - public function rmdir($path) { |
|
| 298 | - $result = $this->storage->rmdir($path); |
|
| 299 | - $fullPath = $this->getFullPath($path); |
|
| 300 | - if ($result && |
|
| 301 | - $this->util->isExcluded($fullPath) === false && |
|
| 302 | - $this->encryptionManager->isEnabled() |
|
| 303 | - ) { |
|
| 304 | - $this->keyStorage->deleteAllFileKeys($fullPath); |
|
| 305 | - } |
|
| 306 | - |
|
| 307 | - return $result; |
|
| 308 | - } |
|
| 309 | - |
|
| 310 | - /** |
|
| 311 | - * check if a file can be read |
|
| 312 | - * |
|
| 313 | - * @param string $path |
|
| 314 | - * @return bool |
|
| 315 | - */ |
|
| 316 | - public function isReadable($path) { |
|
| 317 | - |
|
| 318 | - $isReadable = true; |
|
| 319 | - |
|
| 320 | - $metaData = $this->getMetaData($path); |
|
| 321 | - if ( |
|
| 322 | - !$this->is_dir($path) && |
|
| 323 | - isset($metaData['encrypted']) && |
|
| 324 | - $metaData['encrypted'] === true |
|
| 325 | - ) { |
|
| 326 | - $fullPath = $this->getFullPath($path); |
|
| 327 | - $module = $this->getEncryptionModule($path); |
|
| 328 | - $isReadable = $module->isReadable($fullPath, $this->uid); |
|
| 329 | - } |
|
| 330 | - |
|
| 331 | - return $this->storage->isReadable($path) && $isReadable; |
|
| 332 | - } |
|
| 333 | - |
|
| 334 | - /** |
|
| 335 | - * see http://php.net/manual/en/function.copy.php |
|
| 336 | - * |
|
| 337 | - * @param string $path1 |
|
| 338 | - * @param string $path2 |
|
| 339 | - * @return bool |
|
| 340 | - */ |
|
| 341 | - public function copy($path1, $path2) { |
|
| 342 | - |
|
| 343 | - $source = $this->getFullPath($path1); |
|
| 344 | - |
|
| 345 | - if ($this->util->isExcluded($source)) { |
|
| 346 | - return $this->storage->copy($path1, $path2); |
|
| 347 | - } |
|
| 348 | - |
|
| 349 | - // need to stream copy file by file in case we copy between a encrypted |
|
| 350 | - // and a unencrypted storage |
|
| 351 | - $this->unlink($path2); |
|
| 352 | - $result = $this->copyFromStorage($this, $path1, $path2); |
|
| 353 | - |
|
| 354 | - return $result; |
|
| 355 | - } |
|
| 356 | - |
|
| 357 | - /** |
|
| 358 | - * see http://php.net/manual/en/function.fopen.php |
|
| 359 | - * |
|
| 360 | - * @param string $path |
|
| 361 | - * @param string $mode |
|
| 362 | - * @return resource|bool |
|
| 363 | - * @throws GenericEncryptionException |
|
| 364 | - * @throws ModuleDoesNotExistsException |
|
| 365 | - */ |
|
| 366 | - public function fopen($path, $mode) { |
|
| 367 | - |
|
| 368 | - // check if the file is stored in the array cache, this means that we |
|
| 369 | - // copy a file over to the versions folder, in this case we don't want to |
|
| 370 | - // decrypt it |
|
| 371 | - if ($this->arrayCache->hasKey('encryption_copy_version_' . $path)) { |
|
| 372 | - $this->arrayCache->remove('encryption_copy_version_' . $path); |
|
| 373 | - return $this->storage->fopen($path, $mode); |
|
| 374 | - } |
|
| 375 | - |
|
| 376 | - $encryptionEnabled = $this->encryptionManager->isEnabled(); |
|
| 377 | - $shouldEncrypt = false; |
|
| 378 | - $encryptionModule = null; |
|
| 379 | - $header = $this->getHeader($path); |
|
| 380 | - $signed = (isset($header['signed']) && $header['signed'] === 'true') ? true : false; |
|
| 381 | - $fullPath = $this->getFullPath($path); |
|
| 382 | - $encryptionModuleId = $this->util->getEncryptionModuleId($header); |
|
| 383 | - |
|
| 384 | - if ($this->util->isExcluded($fullPath) === false) { |
|
| 385 | - |
|
| 386 | - $size = $unencryptedSize = 0; |
|
| 387 | - $realFile = $this->util->stripPartialFileExtension($path); |
|
| 388 | - $targetExists = $this->file_exists($realFile) || $this->file_exists($path); |
|
| 389 | - $targetIsEncrypted = false; |
|
| 390 | - if ($targetExists) { |
|
| 391 | - // in case the file exists we require the explicit module as |
|
| 392 | - // specified in the file header - otherwise we need to fail hard to |
|
| 393 | - // prevent data loss on client side |
|
| 394 | - if (!empty($encryptionModuleId)) { |
|
| 395 | - $targetIsEncrypted = true; |
|
| 396 | - $encryptionModule = $this->encryptionManager->getEncryptionModule($encryptionModuleId); |
|
| 397 | - } |
|
| 398 | - |
|
| 399 | - if ($this->file_exists($path)) { |
|
| 400 | - $size = $this->storage->filesize($path); |
|
| 401 | - $unencryptedSize = $this->filesize($path); |
|
| 402 | - } else { |
|
| 403 | - $size = $unencryptedSize = 0; |
|
| 404 | - } |
|
| 405 | - } |
|
| 406 | - |
|
| 407 | - try { |
|
| 408 | - |
|
| 409 | - if ( |
|
| 410 | - $mode === 'w' |
|
| 411 | - || $mode === 'w+' |
|
| 412 | - || $mode === 'wb' |
|
| 413 | - || $mode === 'wb+' |
|
| 414 | - ) { |
|
| 415 | - // don't overwrite encrypted files if encryption is not enabled |
|
| 416 | - if ($targetIsEncrypted && $encryptionEnabled === false) { |
|
| 417 | - throw new GenericEncryptionException('Tried to access encrypted file but encryption is not enabled'); |
|
| 418 | - } |
|
| 419 | - if ($encryptionEnabled) { |
|
| 420 | - // if $encryptionModuleId is empty, the default module will be used |
|
| 421 | - $encryptionModule = $this->encryptionManager->getEncryptionModule($encryptionModuleId); |
|
| 422 | - $shouldEncrypt = $encryptionModule->shouldEncrypt($fullPath); |
|
| 423 | - $signed = true; |
|
| 424 | - } |
|
| 425 | - } else { |
|
| 426 | - $info = $this->getCache()->get($path); |
|
| 427 | - // only get encryption module if we found one in the header |
|
| 428 | - // or if file should be encrypted according to the file cache |
|
| 429 | - if (!empty($encryptionModuleId)) { |
|
| 430 | - $encryptionModule = $this->encryptionManager->getEncryptionModule($encryptionModuleId); |
|
| 431 | - $shouldEncrypt = true; |
|
| 432 | - } else if (empty($encryptionModuleId) && $info['encrypted'] === true) { |
|
| 433 | - // we come from a old installation. No header and/or no module defined |
|
| 434 | - // but the file is encrypted. In this case we need to use the |
|
| 435 | - // OC_DEFAULT_MODULE to read the file |
|
| 436 | - $encryptionModule = $this->encryptionManager->getEncryptionModule('OC_DEFAULT_MODULE'); |
|
| 437 | - $shouldEncrypt = true; |
|
| 438 | - $targetIsEncrypted = true; |
|
| 439 | - } |
|
| 440 | - } |
|
| 441 | - } catch (ModuleDoesNotExistsException $e) { |
|
| 442 | - $this->logger->warning('Encryption module "' . $encryptionModuleId . |
|
| 443 | - '" not found, file will be stored unencrypted (' . $e->getMessage() . ')'); |
|
| 444 | - } |
|
| 445 | - |
|
| 446 | - // encryption disabled on write of new file and write to existing unencrypted file -> don't encrypt |
|
| 447 | - if (!$encryptionEnabled || !$this->shouldEncrypt($path)) { |
|
| 448 | - if (!$targetExists || !$targetIsEncrypted) { |
|
| 449 | - $shouldEncrypt = false; |
|
| 450 | - } |
|
| 451 | - } |
|
| 452 | - |
|
| 453 | - if ($shouldEncrypt === true && $encryptionModule !== null) { |
|
| 454 | - $headerSize = $this->getHeaderSize($path); |
|
| 455 | - $source = $this->storage->fopen($path, $mode); |
|
| 456 | - if (!is_resource($source)) { |
|
| 457 | - return false; |
|
| 458 | - } |
|
| 459 | - $handle = \OC\Files\Stream\Encryption::wrap($source, $path, $fullPath, $header, |
|
| 460 | - $this->uid, $encryptionModule, $this->storage, $this, $this->util, $this->fileHelper, $mode, |
|
| 461 | - $size, $unencryptedSize, $headerSize, $signed); |
|
| 462 | - return $handle; |
|
| 463 | - } |
|
| 464 | - |
|
| 465 | - } |
|
| 466 | - |
|
| 467 | - return $this->storage->fopen($path, $mode); |
|
| 468 | - } |
|
| 469 | - |
|
| 470 | - |
|
| 471 | - /** |
|
| 472 | - * perform some plausibility checks if the the unencrypted size is correct. |
|
| 473 | - * If not, we calculate the correct unencrypted size and return it |
|
| 474 | - * |
|
| 475 | - * @param string $path internal path relative to the storage root |
|
| 476 | - * @param int $unencryptedSize size of the unencrypted file |
|
| 477 | - * |
|
| 478 | - * @return int unencrypted size |
|
| 479 | - */ |
|
| 480 | - protected function verifyUnencryptedSize($path, $unencryptedSize) { |
|
| 481 | - |
|
| 482 | - $size = $this->storage->filesize($path); |
|
| 483 | - $result = $unencryptedSize; |
|
| 484 | - |
|
| 485 | - if ($unencryptedSize < 0 || |
|
| 486 | - ($size > 0 && $unencryptedSize === $size) |
|
| 487 | - ) { |
|
| 488 | - // check if we already calculate the unencrypted size for the |
|
| 489 | - // given path to avoid recursions |
|
| 490 | - if (isset($this->fixUnencryptedSizeOf[$this->getFullPath($path)]) === false) { |
|
| 491 | - $this->fixUnencryptedSizeOf[$this->getFullPath($path)] = true; |
|
| 492 | - try { |
|
| 493 | - $result = $this->fixUnencryptedSize($path, $size, $unencryptedSize); |
|
| 494 | - } catch (\Exception $e) { |
|
| 495 | - $this->logger->error('Couldn\'t re-calculate unencrypted size for '. $path); |
|
| 496 | - $this->logger->logException($e); |
|
| 497 | - } |
|
| 498 | - unset($this->fixUnencryptedSizeOf[$this->getFullPath($path)]); |
|
| 499 | - } |
|
| 500 | - } |
|
| 501 | - |
|
| 502 | - return $result; |
|
| 503 | - } |
|
| 504 | - |
|
| 505 | - /** |
|
| 506 | - * calculate the unencrypted size |
|
| 507 | - * |
|
| 508 | - * @param string $path internal path relative to the storage root |
|
| 509 | - * @param int $size size of the physical file |
|
| 510 | - * @param int $unencryptedSize size of the unencrypted file |
|
| 511 | - * |
|
| 512 | - * @return int calculated unencrypted size |
|
| 513 | - */ |
|
| 514 | - protected function fixUnencryptedSize($path, $size, $unencryptedSize) { |
|
| 515 | - |
|
| 516 | - $headerSize = $this->getHeaderSize($path); |
|
| 517 | - $header = $this->getHeader($path); |
|
| 518 | - $encryptionModule = $this->getEncryptionModule($path); |
|
| 519 | - |
|
| 520 | - $stream = $this->storage->fopen($path, 'r'); |
|
| 521 | - |
|
| 522 | - // if we couldn't open the file we return the old unencrypted size |
|
| 523 | - if (!is_resource($stream)) { |
|
| 524 | - $this->logger->error('Could not open ' . $path . '. Recalculation of unencrypted size aborted.'); |
|
| 525 | - return $unencryptedSize; |
|
| 526 | - } |
|
| 527 | - |
|
| 528 | - $newUnencryptedSize = 0; |
|
| 529 | - $size -= $headerSize; |
|
| 530 | - $blockSize = $this->util->getBlockSize(); |
|
| 531 | - |
|
| 532 | - // if a header exists we skip it |
|
| 533 | - if ($headerSize > 0) { |
|
| 534 | - fread($stream, $headerSize); |
|
| 535 | - } |
|
| 536 | - |
|
| 537 | - // fast path, else the calculation for $lastChunkNr is bogus |
|
| 538 | - if ($size === 0) { |
|
| 539 | - return 0; |
|
| 540 | - } |
|
| 541 | - |
|
| 542 | - $signed = (isset($header['signed']) && $header['signed'] === 'true') ? true : false; |
|
| 543 | - $unencryptedBlockSize = $encryptionModule->getUnencryptedBlockSize($signed); |
|
| 544 | - |
|
| 545 | - // calculate last chunk nr |
|
| 546 | - // next highest is end of chunks, one subtracted is last one |
|
| 547 | - // we have to read the last chunk, we can't just calculate it (because of padding etc) |
|
| 548 | - |
|
| 549 | - $lastChunkNr = ceil($size/ $blockSize)-1; |
|
| 550 | - // calculate last chunk position |
|
| 551 | - $lastChunkPos = ($lastChunkNr * $blockSize); |
|
| 552 | - // try to fseek to the last chunk, if it fails we have to read the whole file |
|
| 553 | - if (@fseek($stream, $lastChunkPos, SEEK_CUR) === 0) { |
|
| 554 | - $newUnencryptedSize += $lastChunkNr * $unencryptedBlockSize; |
|
| 555 | - } |
|
| 556 | - |
|
| 557 | - $lastChunkContentEncrypted=''; |
|
| 558 | - $count = $blockSize; |
|
| 559 | - |
|
| 560 | - while ($count > 0) { |
|
| 561 | - $data=fread($stream, $blockSize); |
|
| 562 | - $count=strlen($data); |
|
| 563 | - $lastChunkContentEncrypted .= $data; |
|
| 564 | - if(strlen($lastChunkContentEncrypted) > $blockSize) { |
|
| 565 | - $newUnencryptedSize += $unencryptedBlockSize; |
|
| 566 | - $lastChunkContentEncrypted=substr($lastChunkContentEncrypted, $blockSize); |
|
| 567 | - } |
|
| 568 | - } |
|
| 569 | - |
|
| 570 | - fclose($stream); |
|
| 571 | - |
|
| 572 | - // we have to decrypt the last chunk to get it actual size |
|
| 573 | - $encryptionModule->begin($this->getFullPath($path), $this->uid, 'r', $header, []); |
|
| 574 | - $decryptedLastChunk = $encryptionModule->decrypt($lastChunkContentEncrypted, $lastChunkNr . 'end'); |
|
| 575 | - $decryptedLastChunk .= $encryptionModule->end($this->getFullPath($path), $lastChunkNr . 'end'); |
|
| 576 | - |
|
| 577 | - // calc the real file size with the size of the last chunk |
|
| 578 | - $newUnencryptedSize += strlen($decryptedLastChunk); |
|
| 579 | - |
|
| 580 | - $this->updateUnencryptedSize($this->getFullPath($path), $newUnencryptedSize); |
|
| 581 | - |
|
| 582 | - // write to cache if applicable |
|
| 583 | - $cache = $this->storage->getCache(); |
|
| 584 | - if ($cache) { |
|
| 585 | - $entry = $cache->get($path); |
|
| 586 | - $cache->update($entry['fileid'], ['size' => $newUnencryptedSize]); |
|
| 587 | - } |
|
| 588 | - |
|
| 589 | - return $newUnencryptedSize; |
|
| 590 | - } |
|
| 591 | - |
|
| 592 | - /** |
|
| 593 | - * @param Storage\IStorage $sourceStorage |
|
| 594 | - * @param string $sourceInternalPath |
|
| 595 | - * @param string $targetInternalPath |
|
| 596 | - * @param bool $preserveMtime |
|
| 597 | - * @return bool |
|
| 598 | - */ |
|
| 599 | - public function moveFromStorage(Storage\IStorage $sourceStorage, $sourceInternalPath, $targetInternalPath, $preserveMtime = true) { |
|
| 600 | - if ($sourceStorage === $this) { |
|
| 601 | - return $this->rename($sourceInternalPath, $targetInternalPath); |
|
| 602 | - } |
|
| 603 | - |
|
| 604 | - // TODO clean this up once the underlying moveFromStorage in OC\Files\Storage\Wrapper\Common is fixed: |
|
| 605 | - // - call $this->storage->moveFromStorage() instead of $this->copyBetweenStorage |
|
| 606 | - // - copy the file cache update from $this->copyBetweenStorage to this method |
|
| 607 | - // - copy the copyKeys() call from $this->copyBetweenStorage to this method |
|
| 608 | - // - remove $this->copyBetweenStorage |
|
| 609 | - |
|
| 610 | - if (!$sourceStorage->isDeletable($sourceInternalPath)) { |
|
| 611 | - return false; |
|
| 612 | - } |
|
| 613 | - |
|
| 614 | - $result = $this->copyBetweenStorage($sourceStorage, $sourceInternalPath, $targetInternalPath, $preserveMtime, true); |
|
| 615 | - if ($result) { |
|
| 616 | - if ($sourceStorage->is_dir($sourceInternalPath)) { |
|
| 617 | - $result &= $sourceStorage->rmdir($sourceInternalPath); |
|
| 618 | - } else { |
|
| 619 | - $result &= $sourceStorage->unlink($sourceInternalPath); |
|
| 620 | - } |
|
| 621 | - } |
|
| 622 | - return $result; |
|
| 623 | - } |
|
| 624 | - |
|
| 625 | - |
|
| 626 | - /** |
|
| 627 | - * @param Storage\IStorage $sourceStorage |
|
| 628 | - * @param string $sourceInternalPath |
|
| 629 | - * @param string $targetInternalPath |
|
| 630 | - * @param bool $preserveMtime |
|
| 631 | - * @param bool $isRename |
|
| 632 | - * @return bool |
|
| 633 | - */ |
|
| 634 | - public function copyFromStorage(Storage\IStorage $sourceStorage, $sourceInternalPath, $targetInternalPath, $preserveMtime = false, $isRename = false) { |
|
| 635 | - |
|
| 636 | - // TODO clean this up once the underlying moveFromStorage in OC\Files\Storage\Wrapper\Common is fixed: |
|
| 637 | - // - call $this->storage->copyFromStorage() instead of $this->copyBetweenStorage |
|
| 638 | - // - copy the file cache update from $this->copyBetweenStorage to this method |
|
| 639 | - // - copy the copyKeys() call from $this->copyBetweenStorage to this method |
|
| 640 | - // - remove $this->copyBetweenStorage |
|
| 641 | - |
|
| 642 | - return $this->copyBetweenStorage($sourceStorage, $sourceInternalPath, $targetInternalPath, $preserveMtime, $isRename); |
|
| 643 | - } |
|
| 644 | - |
|
| 645 | - /** |
|
| 646 | - * Update the encrypted cache version in the database |
|
| 647 | - * |
|
| 648 | - * @param Storage\IStorage $sourceStorage |
|
| 649 | - * @param string $sourceInternalPath |
|
| 650 | - * @param string $targetInternalPath |
|
| 651 | - * @param bool $isRename |
|
| 652 | - */ |
|
| 653 | - private function updateEncryptedVersion(Storage\IStorage $sourceStorage, $sourceInternalPath, $targetInternalPath, $isRename) { |
|
| 654 | - $isEncrypted = $this->encryptionManager->isEnabled() && $this->shouldEncrypt($targetInternalPath) ? 1 : 0; |
|
| 655 | - $cacheInformation = [ |
|
| 656 | - 'encrypted' => (bool)$isEncrypted, |
|
| 657 | - ]; |
|
| 658 | - if($isEncrypted === 1) { |
|
| 659 | - $encryptedVersion = $sourceStorage->getCache()->get($sourceInternalPath)['encryptedVersion']; |
|
| 660 | - |
|
| 661 | - // In case of a move operation from an unencrypted to an encrypted |
|
| 662 | - // storage the old encrypted version would stay with "0" while the |
|
| 663 | - // correct value would be "1". Thus we manually set the value to "1" |
|
| 664 | - // for those cases. |
|
| 665 | - // See also https://github.com/owncloud/core/issues/23078 |
|
| 666 | - if($encryptedVersion === 0) { |
|
| 667 | - $encryptedVersion = 1; |
|
| 668 | - } |
|
| 669 | - |
|
| 670 | - $cacheInformation['encryptedVersion'] = $encryptedVersion; |
|
| 671 | - } |
|
| 672 | - |
|
| 673 | - // in case of a rename we need to manipulate the source cache because |
|
| 674 | - // this information will be kept for the new target |
|
| 675 | - if ($isRename) { |
|
| 676 | - $sourceStorage->getCache()->put($sourceInternalPath, $cacheInformation); |
|
| 677 | - } else { |
|
| 678 | - $this->getCache()->put($targetInternalPath, $cacheInformation); |
|
| 679 | - } |
|
| 680 | - } |
|
| 681 | - |
|
| 682 | - /** |
|
| 683 | - * copy file between two storages |
|
| 684 | - * |
|
| 685 | - * @param Storage\IStorage $sourceStorage |
|
| 686 | - * @param string $sourceInternalPath |
|
| 687 | - * @param string $targetInternalPath |
|
| 688 | - * @param bool $preserveMtime |
|
| 689 | - * @param bool $isRename |
|
| 690 | - * @return bool |
|
| 691 | - * @throws \Exception |
|
| 692 | - */ |
|
| 693 | - private function copyBetweenStorage(Storage\IStorage $sourceStorage, $sourceInternalPath, $targetInternalPath, $preserveMtime, $isRename) { |
|
| 694 | - |
|
| 695 | - // for versions we have nothing to do, because versions should always use the |
|
| 696 | - // key from the original file. Just create a 1:1 copy and done |
|
| 697 | - if ($this->isVersion($targetInternalPath) || |
|
| 698 | - $this->isVersion($sourceInternalPath)) { |
|
| 699 | - // remember that we try to create a version so that we can detect it during |
|
| 700 | - // fopen($sourceInternalPath) and by-pass the encryption in order to |
|
| 701 | - // create a 1:1 copy of the file |
|
| 702 | - $this->arrayCache->set('encryption_copy_version_' . $sourceInternalPath, true); |
|
| 703 | - $result = $this->storage->copyFromStorage($sourceStorage, $sourceInternalPath, $targetInternalPath); |
|
| 704 | - $this->arrayCache->remove('encryption_copy_version_' . $sourceInternalPath); |
|
| 705 | - if ($result) { |
|
| 706 | - $info = $this->getCache('', $sourceStorage)->get($sourceInternalPath); |
|
| 707 | - // make sure that we update the unencrypted size for the version |
|
| 708 | - if (isset($info['encrypted']) && $info['encrypted'] === true) { |
|
| 709 | - $this->updateUnencryptedSize( |
|
| 710 | - $this->getFullPath($targetInternalPath), |
|
| 711 | - $info['size'] |
|
| 712 | - ); |
|
| 713 | - } |
|
| 714 | - $this->updateEncryptedVersion($sourceStorage, $sourceInternalPath, $targetInternalPath, $isRename); |
|
| 715 | - } |
|
| 716 | - return $result; |
|
| 717 | - } |
|
| 718 | - |
|
| 719 | - // first copy the keys that we reuse the existing file key on the target location |
|
| 720 | - // and don't create a new one which would break versions for example. |
|
| 721 | - $mount = $this->mountManager->findByStorageId($sourceStorage->getId()); |
|
| 722 | - if (count($mount) === 1) { |
|
| 723 | - $mountPoint = $mount[0]->getMountPoint(); |
|
| 724 | - $source = $mountPoint . '/' . $sourceInternalPath; |
|
| 725 | - $target = $this->getFullPath($targetInternalPath); |
|
| 726 | - $this->copyKeys($source, $target); |
|
| 727 | - } else { |
|
| 728 | - $this->logger->error('Could not find mount point, can\'t keep encryption keys'); |
|
| 729 | - } |
|
| 730 | - |
|
| 731 | - if ($sourceStorage->is_dir($sourceInternalPath)) { |
|
| 732 | - $dh = $sourceStorage->opendir($sourceInternalPath); |
|
| 733 | - $result = $this->mkdir($targetInternalPath); |
|
| 734 | - if (is_resource($dh)) { |
|
| 735 | - while ($result and ($file = readdir($dh)) !== false) { |
|
| 736 | - if (!Filesystem::isIgnoredDir($file)) { |
|
| 737 | - $result &= $this->copyFromStorage($sourceStorage, $sourceInternalPath . '/' . $file, $targetInternalPath . '/' . $file, false, $isRename); |
|
| 738 | - } |
|
| 739 | - } |
|
| 740 | - } |
|
| 741 | - } else { |
|
| 742 | - try { |
|
| 743 | - $source = $sourceStorage->fopen($sourceInternalPath, 'r'); |
|
| 744 | - $target = $this->fopen($targetInternalPath, 'w'); |
|
| 745 | - list(, $result) = \OC_Helper::streamCopy($source, $target); |
|
| 746 | - fclose($source); |
|
| 747 | - fclose($target); |
|
| 748 | - } catch (\Exception $e) { |
|
| 749 | - fclose($source); |
|
| 750 | - fclose($target); |
|
| 751 | - throw $e; |
|
| 752 | - } |
|
| 753 | - if($result) { |
|
| 754 | - if ($preserveMtime) { |
|
| 755 | - $this->touch($targetInternalPath, $sourceStorage->filemtime($sourceInternalPath)); |
|
| 756 | - } |
|
| 757 | - $this->updateEncryptedVersion($sourceStorage, $sourceInternalPath, $targetInternalPath, $isRename); |
|
| 758 | - } else { |
|
| 759 | - // delete partially written target file |
|
| 760 | - $this->unlink($targetInternalPath); |
|
| 761 | - // delete cache entry that was created by fopen |
|
| 762 | - $this->getCache()->remove($targetInternalPath); |
|
| 763 | - } |
|
| 764 | - } |
|
| 765 | - return (bool)$result; |
|
| 766 | - |
|
| 767 | - } |
|
| 768 | - |
|
| 769 | - /** |
|
| 770 | - * get the path to a local version of the file. |
|
| 771 | - * The local version of the file can be temporary and doesn't have to be persistent across requests |
|
| 772 | - * |
|
| 773 | - * @param string $path |
|
| 774 | - * @return string |
|
| 775 | - */ |
|
| 776 | - public function getLocalFile($path) { |
|
| 777 | - if ($this->encryptionManager->isEnabled()) { |
|
| 778 | - $cachedFile = $this->getCachedFile($path); |
|
| 779 | - if (is_string($cachedFile)) { |
|
| 780 | - return $cachedFile; |
|
| 781 | - } |
|
| 782 | - } |
|
| 783 | - return $this->storage->getLocalFile($path); |
|
| 784 | - } |
|
| 785 | - |
|
| 786 | - /** |
|
| 787 | - * Returns the wrapped storage's value for isLocal() |
|
| 788 | - * |
|
| 789 | - * @return bool wrapped storage's isLocal() value |
|
| 790 | - */ |
|
| 791 | - public function isLocal() { |
|
| 792 | - if ($this->encryptionManager->isEnabled()) { |
|
| 793 | - return false; |
|
| 794 | - } |
|
| 795 | - return $this->storage->isLocal(); |
|
| 796 | - } |
|
| 797 | - |
|
| 798 | - /** |
|
| 799 | - * see http://php.net/manual/en/function.stat.php |
|
| 800 | - * only the following keys are required in the result: size and mtime |
|
| 801 | - * |
|
| 802 | - * @param string $path |
|
| 803 | - * @return array |
|
| 804 | - */ |
|
| 805 | - public function stat($path) { |
|
| 806 | - $stat = $this->storage->stat($path); |
|
| 807 | - $fileSize = $this->filesize($path); |
|
| 808 | - $stat['size'] = $fileSize; |
|
| 809 | - $stat[7] = $fileSize; |
|
| 810 | - return $stat; |
|
| 811 | - } |
|
| 812 | - |
|
| 813 | - /** |
|
| 814 | - * see http://php.net/manual/en/function.hash.php |
|
| 815 | - * |
|
| 816 | - * @param string $type |
|
| 817 | - * @param string $path |
|
| 818 | - * @param bool $raw |
|
| 819 | - * @return string |
|
| 820 | - */ |
|
| 821 | - public function hash($type, $path, $raw = false) { |
|
| 822 | - $fh = $this->fopen($path, 'rb'); |
|
| 823 | - $ctx = hash_init($type); |
|
| 824 | - hash_update_stream($ctx, $fh); |
|
| 825 | - fclose($fh); |
|
| 826 | - return hash_final($ctx, $raw); |
|
| 827 | - } |
|
| 828 | - |
|
| 829 | - /** |
|
| 830 | - * return full path, including mount point |
|
| 831 | - * |
|
| 832 | - * @param string $path relative to mount point |
|
| 833 | - * @return string full path including mount point |
|
| 834 | - */ |
|
| 835 | - protected function getFullPath($path) { |
|
| 836 | - return Filesystem::normalizePath($this->mountPoint . '/' . $path); |
|
| 837 | - } |
|
| 838 | - |
|
| 839 | - /** |
|
| 840 | - * read first block of encrypted file, typically this will contain the |
|
| 841 | - * encryption header |
|
| 842 | - * |
|
| 843 | - * @param string $path |
|
| 844 | - * @return string |
|
| 845 | - */ |
|
| 846 | - protected function readFirstBlock($path) { |
|
| 847 | - $firstBlock = ''; |
|
| 848 | - if ($this->storage->file_exists($path)) { |
|
| 849 | - $handle = $this->storage->fopen($path, 'r'); |
|
| 850 | - $firstBlock = fread($handle, $this->util->getHeaderSize()); |
|
| 851 | - fclose($handle); |
|
| 852 | - } |
|
| 853 | - return $firstBlock; |
|
| 854 | - } |
|
| 855 | - |
|
| 856 | - /** |
|
| 857 | - * return header size of given file |
|
| 858 | - * |
|
| 859 | - * @param string $path |
|
| 860 | - * @return int |
|
| 861 | - */ |
|
| 862 | - protected function getHeaderSize($path) { |
|
| 863 | - $headerSize = 0; |
|
| 864 | - $realFile = $this->util->stripPartialFileExtension($path); |
|
| 865 | - if ($this->storage->file_exists($realFile)) { |
|
| 866 | - $path = $realFile; |
|
| 867 | - } |
|
| 868 | - $firstBlock = $this->readFirstBlock($path); |
|
| 869 | - |
|
| 870 | - if (substr($firstBlock, 0, strlen(Util::HEADER_START)) === Util::HEADER_START) { |
|
| 871 | - $headerSize = $this->util->getHeaderSize(); |
|
| 872 | - } |
|
| 873 | - |
|
| 874 | - return $headerSize; |
|
| 875 | - } |
|
| 876 | - |
|
| 877 | - /** |
|
| 878 | - * parse raw header to array |
|
| 879 | - * |
|
| 880 | - * @param string $rawHeader |
|
| 881 | - * @return array |
|
| 882 | - */ |
|
| 883 | - protected function parseRawHeader($rawHeader) { |
|
| 884 | - $result = array(); |
|
| 885 | - if (substr($rawHeader, 0, strlen(Util::HEADER_START)) === Util::HEADER_START) { |
|
| 886 | - $header = $rawHeader; |
|
| 887 | - $endAt = strpos($header, Util::HEADER_END); |
|
| 888 | - if ($endAt !== false) { |
|
| 889 | - $header = substr($header, 0, $endAt + strlen(Util::HEADER_END)); |
|
| 890 | - |
|
| 891 | - // +1 to not start with an ':' which would result in empty element at the beginning |
|
| 892 | - $exploded = explode(':', substr($header, strlen(Util::HEADER_START)+1)); |
|
| 893 | - |
|
| 894 | - $element = array_shift($exploded); |
|
| 895 | - while ($element !== Util::HEADER_END) { |
|
| 896 | - $result[$element] = array_shift($exploded); |
|
| 897 | - $element = array_shift($exploded); |
|
| 898 | - } |
|
| 899 | - } |
|
| 900 | - } |
|
| 901 | - |
|
| 902 | - return $result; |
|
| 903 | - } |
|
| 904 | - |
|
| 905 | - /** |
|
| 906 | - * read header from file |
|
| 907 | - * |
|
| 908 | - * @param string $path |
|
| 909 | - * @return array |
|
| 910 | - */ |
|
| 911 | - protected function getHeader($path) { |
|
| 912 | - $realFile = $this->util->stripPartialFileExtension($path); |
|
| 913 | - $exists = $this->storage->file_exists($realFile); |
|
| 914 | - if ($exists) { |
|
| 915 | - $path = $realFile; |
|
| 916 | - } |
|
| 917 | - |
|
| 918 | - $firstBlock = $this->readFirstBlock($path); |
|
| 919 | - $result = $this->parseRawHeader($firstBlock); |
|
| 920 | - |
|
| 921 | - // if the header doesn't contain a encryption module we check if it is a |
|
| 922 | - // legacy file. If true, we add the default encryption module |
|
| 923 | - if (!isset($result[Util::HEADER_ENCRYPTION_MODULE_KEY])) { |
|
| 924 | - if (!empty($result)) { |
|
| 925 | - $result[Util::HEADER_ENCRYPTION_MODULE_KEY] = 'OC_DEFAULT_MODULE'; |
|
| 926 | - } else if ($exists) { |
|
| 927 | - // if the header was empty we have to check first if it is a encrypted file at all |
|
| 928 | - // We would do query to filecache only if we know that entry in filecache exists |
|
| 929 | - $info = $this->getCache()->get($path); |
|
| 930 | - if (isset($info['encrypted']) && $info['encrypted'] === true) { |
|
| 931 | - $result[Util::HEADER_ENCRYPTION_MODULE_KEY] = 'OC_DEFAULT_MODULE'; |
|
| 932 | - } |
|
| 933 | - } |
|
| 934 | - } |
|
| 935 | - |
|
| 936 | - return $result; |
|
| 937 | - } |
|
| 938 | - |
|
| 939 | - /** |
|
| 940 | - * read encryption module needed to read/write the file located at $path |
|
| 941 | - * |
|
| 942 | - * @param string $path |
|
| 943 | - * @return null|\OCP\Encryption\IEncryptionModule |
|
| 944 | - * @throws ModuleDoesNotExistsException |
|
| 945 | - * @throws \Exception |
|
| 946 | - */ |
|
| 947 | - protected function getEncryptionModule($path) { |
|
| 948 | - $encryptionModule = null; |
|
| 949 | - $header = $this->getHeader($path); |
|
| 950 | - $encryptionModuleId = $this->util->getEncryptionModuleId($header); |
|
| 951 | - if (!empty($encryptionModuleId)) { |
|
| 952 | - try { |
|
| 953 | - $encryptionModule = $this->encryptionManager->getEncryptionModule($encryptionModuleId); |
|
| 954 | - } catch (ModuleDoesNotExistsException $e) { |
|
| 955 | - $this->logger->critical('Encryption module defined in "' . $path . '" not loaded!'); |
|
| 956 | - throw $e; |
|
| 957 | - } |
|
| 958 | - } |
|
| 959 | - |
|
| 960 | - return $encryptionModule; |
|
| 961 | - } |
|
| 962 | - |
|
| 963 | - /** |
|
| 964 | - * @param string $path |
|
| 965 | - * @param int $unencryptedSize |
|
| 966 | - */ |
|
| 967 | - public function updateUnencryptedSize($path, $unencryptedSize) { |
|
| 968 | - $this->unencryptedSize[$path] = $unencryptedSize; |
|
| 969 | - } |
|
| 970 | - |
|
| 971 | - /** |
|
| 972 | - * copy keys to new location |
|
| 973 | - * |
|
| 974 | - * @param string $source path relative to data/ |
|
| 975 | - * @param string $target path relative to data/ |
|
| 976 | - * @return bool |
|
| 977 | - */ |
|
| 978 | - protected function copyKeys($source, $target) { |
|
| 979 | - if (!$this->util->isExcluded($source)) { |
|
| 980 | - return $this->keyStorage->copyKeys($source, $target); |
|
| 981 | - } |
|
| 982 | - |
|
| 983 | - return false; |
|
| 984 | - } |
|
| 985 | - |
|
| 986 | - /** |
|
| 987 | - * check if path points to a files version |
|
| 988 | - * |
|
| 989 | - * @param $path |
|
| 990 | - * @return bool |
|
| 991 | - */ |
|
| 992 | - protected function isVersion($path) { |
|
| 993 | - $normalized = Filesystem::normalizePath($path); |
|
| 994 | - return substr($normalized, 0, strlen('/files_versions/')) === '/files_versions/'; |
|
| 995 | - } |
|
| 996 | - |
|
| 997 | - /** |
|
| 998 | - * check if the given storage should be encrypted or not |
|
| 999 | - * |
|
| 1000 | - * @param $path |
|
| 1001 | - * @return bool |
|
| 1002 | - */ |
|
| 1003 | - protected function shouldEncrypt($path) { |
|
| 1004 | - $fullPath = $this->getFullPath($path); |
|
| 1005 | - $mountPointConfig = $this->mount->getOption('encrypt', true); |
|
| 1006 | - if ($mountPointConfig === false) { |
|
| 1007 | - return false; |
|
| 1008 | - } |
|
| 1009 | - |
|
| 1010 | - try { |
|
| 1011 | - $encryptionModule = $this->getEncryptionModule($fullPath); |
|
| 1012 | - } catch (ModuleDoesNotExistsException $e) { |
|
| 1013 | - return false; |
|
| 1014 | - } |
|
| 1015 | - |
|
| 1016 | - if ($encryptionModule === null) { |
|
| 1017 | - $encryptionModule = $this->encryptionManager->getEncryptionModule(); |
|
| 1018 | - } |
|
| 1019 | - |
|
| 1020 | - return $encryptionModule->shouldEncrypt($fullPath); |
|
| 1021 | - |
|
| 1022 | - } |
|
| 49 | + use LocalTempFileTrait; |
|
| 50 | + |
|
| 51 | + /** @var string */ |
|
| 52 | + private $mountPoint; |
|
| 53 | + |
|
| 54 | + /** @var \OC\Encryption\Util */ |
|
| 55 | + private $util; |
|
| 56 | + |
|
| 57 | + /** @var \OCP\Encryption\IManager */ |
|
| 58 | + private $encryptionManager; |
|
| 59 | + |
|
| 60 | + /** @var \OCP\ILogger */ |
|
| 61 | + private $logger; |
|
| 62 | + |
|
| 63 | + /** @var string */ |
|
| 64 | + private $uid; |
|
| 65 | + |
|
| 66 | + /** @var array */ |
|
| 67 | + protected $unencryptedSize; |
|
| 68 | + |
|
| 69 | + /** @var \OCP\Encryption\IFile */ |
|
| 70 | + private $fileHelper; |
|
| 71 | + |
|
| 72 | + /** @var IMountPoint */ |
|
| 73 | + private $mount; |
|
| 74 | + |
|
| 75 | + /** @var IStorage */ |
|
| 76 | + private $keyStorage; |
|
| 77 | + |
|
| 78 | + /** @var Update */ |
|
| 79 | + private $update; |
|
| 80 | + |
|
| 81 | + /** @var Manager */ |
|
| 82 | + private $mountManager; |
|
| 83 | + |
|
| 84 | + /** @var array remember for which path we execute the repair step to avoid recursions */ |
|
| 85 | + private $fixUnencryptedSizeOf = array(); |
|
| 86 | + |
|
| 87 | + /** @var ArrayCache */ |
|
| 88 | + private $arrayCache; |
|
| 89 | + |
|
| 90 | + /** |
|
| 91 | + * @param array $parameters |
|
| 92 | + * @param IManager $encryptionManager |
|
| 93 | + * @param Util $util |
|
| 94 | + * @param ILogger $logger |
|
| 95 | + * @param IFile $fileHelper |
|
| 96 | + * @param string $uid |
|
| 97 | + * @param IStorage $keyStorage |
|
| 98 | + * @param Update $update |
|
| 99 | + * @param Manager $mountManager |
|
| 100 | + * @param ArrayCache $arrayCache |
|
| 101 | + */ |
|
| 102 | + public function __construct( |
|
| 103 | + $parameters, |
|
| 104 | + IManager $encryptionManager = null, |
|
| 105 | + Util $util = null, |
|
| 106 | + ILogger $logger = null, |
|
| 107 | + IFile $fileHelper = null, |
|
| 108 | + $uid = null, |
|
| 109 | + IStorage $keyStorage = null, |
|
| 110 | + Update $update = null, |
|
| 111 | + Manager $mountManager = null, |
|
| 112 | + ArrayCache $arrayCache = null |
|
| 113 | + ) { |
|
| 114 | + |
|
| 115 | + $this->mountPoint = $parameters['mountPoint']; |
|
| 116 | + $this->mount = $parameters['mount']; |
|
| 117 | + $this->encryptionManager = $encryptionManager; |
|
| 118 | + $this->util = $util; |
|
| 119 | + $this->logger = $logger; |
|
| 120 | + $this->uid = $uid; |
|
| 121 | + $this->fileHelper = $fileHelper; |
|
| 122 | + $this->keyStorage = $keyStorage; |
|
| 123 | + $this->unencryptedSize = array(); |
|
| 124 | + $this->update = $update; |
|
| 125 | + $this->mountManager = $mountManager; |
|
| 126 | + $this->arrayCache = $arrayCache; |
|
| 127 | + parent::__construct($parameters); |
|
| 128 | + } |
|
| 129 | + |
|
| 130 | + /** |
|
| 131 | + * see http://php.net/manual/en/function.filesize.php |
|
| 132 | + * The result for filesize when called on a folder is required to be 0 |
|
| 133 | + * |
|
| 134 | + * @param string $path |
|
| 135 | + * @return int |
|
| 136 | + */ |
|
| 137 | + public function filesize($path) { |
|
| 138 | + $fullPath = $this->getFullPath($path); |
|
| 139 | + |
|
| 140 | + /** @var CacheEntry $info */ |
|
| 141 | + $info = $this->getCache()->get($path); |
|
| 142 | + if (isset($this->unencryptedSize[$fullPath])) { |
|
| 143 | + $size = $this->unencryptedSize[$fullPath]; |
|
| 144 | + // update file cache |
|
| 145 | + if ($info instanceof ICacheEntry) { |
|
| 146 | + $info = $info->getData(); |
|
| 147 | + $info['encrypted'] = $info['encryptedVersion']; |
|
| 148 | + } else { |
|
| 149 | + if (!is_array($info)) { |
|
| 150 | + $info = []; |
|
| 151 | + } |
|
| 152 | + $info['encrypted'] = true; |
|
| 153 | + } |
|
| 154 | + |
|
| 155 | + $info['size'] = $size; |
|
| 156 | + $this->getCache()->put($path, $info); |
|
| 157 | + |
|
| 158 | + return $size; |
|
| 159 | + } |
|
| 160 | + |
|
| 161 | + if (isset($info['fileid']) && $info['encrypted']) { |
|
| 162 | + return $this->verifyUnencryptedSize($path, $info['size']); |
|
| 163 | + } |
|
| 164 | + |
|
| 165 | + return $this->storage->filesize($path); |
|
| 166 | + } |
|
| 167 | + |
|
| 168 | + /** |
|
| 169 | + * @param string $path |
|
| 170 | + * @return array |
|
| 171 | + */ |
|
| 172 | + public function getMetaData($path) { |
|
| 173 | + $data = $this->storage->getMetaData($path); |
|
| 174 | + if (is_null($data)) { |
|
| 175 | + return null; |
|
| 176 | + } |
|
| 177 | + $fullPath = $this->getFullPath($path); |
|
| 178 | + $info = $this->getCache()->get($path); |
|
| 179 | + |
|
| 180 | + if (isset($this->unencryptedSize[$fullPath])) { |
|
| 181 | + $data['encrypted'] = true; |
|
| 182 | + $data['size'] = $this->unencryptedSize[$fullPath]; |
|
| 183 | + } else { |
|
| 184 | + if (isset($info['fileid']) && $info['encrypted']) { |
|
| 185 | + $data['size'] = $this->verifyUnencryptedSize($path, $info['size']); |
|
| 186 | + $data['encrypted'] = true; |
|
| 187 | + } |
|
| 188 | + } |
|
| 189 | + |
|
| 190 | + if (isset($info['encryptedVersion']) && $info['encryptedVersion'] > 1) { |
|
| 191 | + $data['encryptedVersion'] = $info['encryptedVersion']; |
|
| 192 | + } |
|
| 193 | + |
|
| 194 | + return $data; |
|
| 195 | + } |
|
| 196 | + |
|
| 197 | + /** |
|
| 198 | + * see http://php.net/manual/en/function.file_get_contents.php |
|
| 199 | + * |
|
| 200 | + * @param string $path |
|
| 201 | + * @return string |
|
| 202 | + */ |
|
| 203 | + public function file_get_contents($path) { |
|
| 204 | + |
|
| 205 | + $encryptionModule = $this->getEncryptionModule($path); |
|
| 206 | + |
|
| 207 | + if ($encryptionModule) { |
|
| 208 | + $handle = $this->fopen($path, "r"); |
|
| 209 | + if (!$handle) { |
|
| 210 | + return false; |
|
| 211 | + } |
|
| 212 | + $data = stream_get_contents($handle); |
|
| 213 | + fclose($handle); |
|
| 214 | + return $data; |
|
| 215 | + } |
|
| 216 | + return $this->storage->file_get_contents($path); |
|
| 217 | + } |
|
| 218 | + |
|
| 219 | + /** |
|
| 220 | + * see http://php.net/manual/en/function.file_put_contents.php |
|
| 221 | + * |
|
| 222 | + * @param string $path |
|
| 223 | + * @param string $data |
|
| 224 | + * @return bool |
|
| 225 | + */ |
|
| 226 | + public function file_put_contents($path, $data) { |
|
| 227 | + // file put content will always be translated to a stream write |
|
| 228 | + $handle = $this->fopen($path, 'w'); |
|
| 229 | + if (is_resource($handle)) { |
|
| 230 | + $written = fwrite($handle, $data); |
|
| 231 | + fclose($handle); |
|
| 232 | + return $written; |
|
| 233 | + } |
|
| 234 | + |
|
| 235 | + return false; |
|
| 236 | + } |
|
| 237 | + |
|
| 238 | + /** |
|
| 239 | + * see http://php.net/manual/en/function.unlink.php |
|
| 240 | + * |
|
| 241 | + * @param string $path |
|
| 242 | + * @return bool |
|
| 243 | + */ |
|
| 244 | + public function unlink($path) { |
|
| 245 | + $fullPath = $this->getFullPath($path); |
|
| 246 | + if ($this->util->isExcluded($fullPath)) { |
|
| 247 | + return $this->storage->unlink($path); |
|
| 248 | + } |
|
| 249 | + |
|
| 250 | + $encryptionModule = $this->getEncryptionModule($path); |
|
| 251 | + if ($encryptionModule) { |
|
| 252 | + $this->keyStorage->deleteAllFileKeys($this->getFullPath($path)); |
|
| 253 | + } |
|
| 254 | + |
|
| 255 | + return $this->storage->unlink($path); |
|
| 256 | + } |
|
| 257 | + |
|
| 258 | + /** |
|
| 259 | + * see http://php.net/manual/en/function.rename.php |
|
| 260 | + * |
|
| 261 | + * @param string $path1 |
|
| 262 | + * @param string $path2 |
|
| 263 | + * @return bool |
|
| 264 | + */ |
|
| 265 | + public function rename($path1, $path2) { |
|
| 266 | + |
|
| 267 | + $result = $this->storage->rename($path1, $path2); |
|
| 268 | + |
|
| 269 | + if ($result && |
|
| 270 | + // versions always use the keys from the original file, so we can skip |
|
| 271 | + // this step for versions |
|
| 272 | + $this->isVersion($path2) === false && |
|
| 273 | + $this->encryptionManager->isEnabled()) { |
|
| 274 | + $source = $this->getFullPath($path1); |
|
| 275 | + if (!$this->util->isExcluded($source)) { |
|
| 276 | + $target = $this->getFullPath($path2); |
|
| 277 | + if (isset($this->unencryptedSize[$source])) { |
|
| 278 | + $this->unencryptedSize[$target] = $this->unencryptedSize[$source]; |
|
| 279 | + } |
|
| 280 | + $this->keyStorage->renameKeys($source, $target); |
|
| 281 | + $module = $this->getEncryptionModule($path2); |
|
| 282 | + if ($module) { |
|
| 283 | + $module->update($target, $this->uid, []); |
|
| 284 | + } |
|
| 285 | + } |
|
| 286 | + } |
|
| 287 | + |
|
| 288 | + return $result; |
|
| 289 | + } |
|
| 290 | + |
|
| 291 | + /** |
|
| 292 | + * see http://php.net/manual/en/function.rmdir.php |
|
| 293 | + * |
|
| 294 | + * @param string $path |
|
| 295 | + * @return bool |
|
| 296 | + */ |
|
| 297 | + public function rmdir($path) { |
|
| 298 | + $result = $this->storage->rmdir($path); |
|
| 299 | + $fullPath = $this->getFullPath($path); |
|
| 300 | + if ($result && |
|
| 301 | + $this->util->isExcluded($fullPath) === false && |
|
| 302 | + $this->encryptionManager->isEnabled() |
|
| 303 | + ) { |
|
| 304 | + $this->keyStorage->deleteAllFileKeys($fullPath); |
|
| 305 | + } |
|
| 306 | + |
|
| 307 | + return $result; |
|
| 308 | + } |
|
| 309 | + |
|
| 310 | + /** |
|
| 311 | + * check if a file can be read |
|
| 312 | + * |
|
| 313 | + * @param string $path |
|
| 314 | + * @return bool |
|
| 315 | + */ |
|
| 316 | + public function isReadable($path) { |
|
| 317 | + |
|
| 318 | + $isReadable = true; |
|
| 319 | + |
|
| 320 | + $metaData = $this->getMetaData($path); |
|
| 321 | + if ( |
|
| 322 | + !$this->is_dir($path) && |
|
| 323 | + isset($metaData['encrypted']) && |
|
| 324 | + $metaData['encrypted'] === true |
|
| 325 | + ) { |
|
| 326 | + $fullPath = $this->getFullPath($path); |
|
| 327 | + $module = $this->getEncryptionModule($path); |
|
| 328 | + $isReadable = $module->isReadable($fullPath, $this->uid); |
|
| 329 | + } |
|
| 330 | + |
|
| 331 | + return $this->storage->isReadable($path) && $isReadable; |
|
| 332 | + } |
|
| 333 | + |
|
| 334 | + /** |
|
| 335 | + * see http://php.net/manual/en/function.copy.php |
|
| 336 | + * |
|
| 337 | + * @param string $path1 |
|
| 338 | + * @param string $path2 |
|
| 339 | + * @return bool |
|
| 340 | + */ |
|
| 341 | + public function copy($path1, $path2) { |
|
| 342 | + |
|
| 343 | + $source = $this->getFullPath($path1); |
|
| 344 | + |
|
| 345 | + if ($this->util->isExcluded($source)) { |
|
| 346 | + return $this->storage->copy($path1, $path2); |
|
| 347 | + } |
|
| 348 | + |
|
| 349 | + // need to stream copy file by file in case we copy between a encrypted |
|
| 350 | + // and a unencrypted storage |
|
| 351 | + $this->unlink($path2); |
|
| 352 | + $result = $this->copyFromStorage($this, $path1, $path2); |
|
| 353 | + |
|
| 354 | + return $result; |
|
| 355 | + } |
|
| 356 | + |
|
| 357 | + /** |
|
| 358 | + * see http://php.net/manual/en/function.fopen.php |
|
| 359 | + * |
|
| 360 | + * @param string $path |
|
| 361 | + * @param string $mode |
|
| 362 | + * @return resource|bool |
|
| 363 | + * @throws GenericEncryptionException |
|
| 364 | + * @throws ModuleDoesNotExistsException |
|
| 365 | + */ |
|
| 366 | + public function fopen($path, $mode) { |
|
| 367 | + |
|
| 368 | + // check if the file is stored in the array cache, this means that we |
|
| 369 | + // copy a file over to the versions folder, in this case we don't want to |
|
| 370 | + // decrypt it |
|
| 371 | + if ($this->arrayCache->hasKey('encryption_copy_version_' . $path)) { |
|
| 372 | + $this->arrayCache->remove('encryption_copy_version_' . $path); |
|
| 373 | + return $this->storage->fopen($path, $mode); |
|
| 374 | + } |
|
| 375 | + |
|
| 376 | + $encryptionEnabled = $this->encryptionManager->isEnabled(); |
|
| 377 | + $shouldEncrypt = false; |
|
| 378 | + $encryptionModule = null; |
|
| 379 | + $header = $this->getHeader($path); |
|
| 380 | + $signed = (isset($header['signed']) && $header['signed'] === 'true') ? true : false; |
|
| 381 | + $fullPath = $this->getFullPath($path); |
|
| 382 | + $encryptionModuleId = $this->util->getEncryptionModuleId($header); |
|
| 383 | + |
|
| 384 | + if ($this->util->isExcluded($fullPath) === false) { |
|
| 385 | + |
|
| 386 | + $size = $unencryptedSize = 0; |
|
| 387 | + $realFile = $this->util->stripPartialFileExtension($path); |
|
| 388 | + $targetExists = $this->file_exists($realFile) || $this->file_exists($path); |
|
| 389 | + $targetIsEncrypted = false; |
|
| 390 | + if ($targetExists) { |
|
| 391 | + // in case the file exists we require the explicit module as |
|
| 392 | + // specified in the file header - otherwise we need to fail hard to |
|
| 393 | + // prevent data loss on client side |
|
| 394 | + if (!empty($encryptionModuleId)) { |
|
| 395 | + $targetIsEncrypted = true; |
|
| 396 | + $encryptionModule = $this->encryptionManager->getEncryptionModule($encryptionModuleId); |
|
| 397 | + } |
|
| 398 | + |
|
| 399 | + if ($this->file_exists($path)) { |
|
| 400 | + $size = $this->storage->filesize($path); |
|
| 401 | + $unencryptedSize = $this->filesize($path); |
|
| 402 | + } else { |
|
| 403 | + $size = $unencryptedSize = 0; |
|
| 404 | + } |
|
| 405 | + } |
|
| 406 | + |
|
| 407 | + try { |
|
| 408 | + |
|
| 409 | + if ( |
|
| 410 | + $mode === 'w' |
|
| 411 | + || $mode === 'w+' |
|
| 412 | + || $mode === 'wb' |
|
| 413 | + || $mode === 'wb+' |
|
| 414 | + ) { |
|
| 415 | + // don't overwrite encrypted files if encryption is not enabled |
|
| 416 | + if ($targetIsEncrypted && $encryptionEnabled === false) { |
|
| 417 | + throw new GenericEncryptionException('Tried to access encrypted file but encryption is not enabled'); |
|
| 418 | + } |
|
| 419 | + if ($encryptionEnabled) { |
|
| 420 | + // if $encryptionModuleId is empty, the default module will be used |
|
| 421 | + $encryptionModule = $this->encryptionManager->getEncryptionModule($encryptionModuleId); |
|
| 422 | + $shouldEncrypt = $encryptionModule->shouldEncrypt($fullPath); |
|
| 423 | + $signed = true; |
|
| 424 | + } |
|
| 425 | + } else { |
|
| 426 | + $info = $this->getCache()->get($path); |
|
| 427 | + // only get encryption module if we found one in the header |
|
| 428 | + // or if file should be encrypted according to the file cache |
|
| 429 | + if (!empty($encryptionModuleId)) { |
|
| 430 | + $encryptionModule = $this->encryptionManager->getEncryptionModule($encryptionModuleId); |
|
| 431 | + $shouldEncrypt = true; |
|
| 432 | + } else if (empty($encryptionModuleId) && $info['encrypted'] === true) { |
|
| 433 | + // we come from a old installation. No header and/or no module defined |
|
| 434 | + // but the file is encrypted. In this case we need to use the |
|
| 435 | + // OC_DEFAULT_MODULE to read the file |
|
| 436 | + $encryptionModule = $this->encryptionManager->getEncryptionModule('OC_DEFAULT_MODULE'); |
|
| 437 | + $shouldEncrypt = true; |
|
| 438 | + $targetIsEncrypted = true; |
|
| 439 | + } |
|
| 440 | + } |
|
| 441 | + } catch (ModuleDoesNotExistsException $e) { |
|
| 442 | + $this->logger->warning('Encryption module "' . $encryptionModuleId . |
|
| 443 | + '" not found, file will be stored unencrypted (' . $e->getMessage() . ')'); |
|
| 444 | + } |
|
| 445 | + |
|
| 446 | + // encryption disabled on write of new file and write to existing unencrypted file -> don't encrypt |
|
| 447 | + if (!$encryptionEnabled || !$this->shouldEncrypt($path)) { |
|
| 448 | + if (!$targetExists || !$targetIsEncrypted) { |
|
| 449 | + $shouldEncrypt = false; |
|
| 450 | + } |
|
| 451 | + } |
|
| 452 | + |
|
| 453 | + if ($shouldEncrypt === true && $encryptionModule !== null) { |
|
| 454 | + $headerSize = $this->getHeaderSize($path); |
|
| 455 | + $source = $this->storage->fopen($path, $mode); |
|
| 456 | + if (!is_resource($source)) { |
|
| 457 | + return false; |
|
| 458 | + } |
|
| 459 | + $handle = \OC\Files\Stream\Encryption::wrap($source, $path, $fullPath, $header, |
|
| 460 | + $this->uid, $encryptionModule, $this->storage, $this, $this->util, $this->fileHelper, $mode, |
|
| 461 | + $size, $unencryptedSize, $headerSize, $signed); |
|
| 462 | + return $handle; |
|
| 463 | + } |
|
| 464 | + |
|
| 465 | + } |
|
| 466 | + |
|
| 467 | + return $this->storage->fopen($path, $mode); |
|
| 468 | + } |
|
| 469 | + |
|
| 470 | + |
|
| 471 | + /** |
|
| 472 | + * perform some plausibility checks if the the unencrypted size is correct. |
|
| 473 | + * If not, we calculate the correct unencrypted size and return it |
|
| 474 | + * |
|
| 475 | + * @param string $path internal path relative to the storage root |
|
| 476 | + * @param int $unencryptedSize size of the unencrypted file |
|
| 477 | + * |
|
| 478 | + * @return int unencrypted size |
|
| 479 | + */ |
|
| 480 | + protected function verifyUnencryptedSize($path, $unencryptedSize) { |
|
| 481 | + |
|
| 482 | + $size = $this->storage->filesize($path); |
|
| 483 | + $result = $unencryptedSize; |
|
| 484 | + |
|
| 485 | + if ($unencryptedSize < 0 || |
|
| 486 | + ($size > 0 && $unencryptedSize === $size) |
|
| 487 | + ) { |
|
| 488 | + // check if we already calculate the unencrypted size for the |
|
| 489 | + // given path to avoid recursions |
|
| 490 | + if (isset($this->fixUnencryptedSizeOf[$this->getFullPath($path)]) === false) { |
|
| 491 | + $this->fixUnencryptedSizeOf[$this->getFullPath($path)] = true; |
|
| 492 | + try { |
|
| 493 | + $result = $this->fixUnencryptedSize($path, $size, $unencryptedSize); |
|
| 494 | + } catch (\Exception $e) { |
|
| 495 | + $this->logger->error('Couldn\'t re-calculate unencrypted size for '. $path); |
|
| 496 | + $this->logger->logException($e); |
|
| 497 | + } |
|
| 498 | + unset($this->fixUnencryptedSizeOf[$this->getFullPath($path)]); |
|
| 499 | + } |
|
| 500 | + } |
|
| 501 | + |
|
| 502 | + return $result; |
|
| 503 | + } |
|
| 504 | + |
|
| 505 | + /** |
|
| 506 | + * calculate the unencrypted size |
|
| 507 | + * |
|
| 508 | + * @param string $path internal path relative to the storage root |
|
| 509 | + * @param int $size size of the physical file |
|
| 510 | + * @param int $unencryptedSize size of the unencrypted file |
|
| 511 | + * |
|
| 512 | + * @return int calculated unencrypted size |
|
| 513 | + */ |
|
| 514 | + protected function fixUnencryptedSize($path, $size, $unencryptedSize) { |
|
| 515 | + |
|
| 516 | + $headerSize = $this->getHeaderSize($path); |
|
| 517 | + $header = $this->getHeader($path); |
|
| 518 | + $encryptionModule = $this->getEncryptionModule($path); |
|
| 519 | + |
|
| 520 | + $stream = $this->storage->fopen($path, 'r'); |
|
| 521 | + |
|
| 522 | + // if we couldn't open the file we return the old unencrypted size |
|
| 523 | + if (!is_resource($stream)) { |
|
| 524 | + $this->logger->error('Could not open ' . $path . '. Recalculation of unencrypted size aborted.'); |
|
| 525 | + return $unencryptedSize; |
|
| 526 | + } |
|
| 527 | + |
|
| 528 | + $newUnencryptedSize = 0; |
|
| 529 | + $size -= $headerSize; |
|
| 530 | + $blockSize = $this->util->getBlockSize(); |
|
| 531 | + |
|
| 532 | + // if a header exists we skip it |
|
| 533 | + if ($headerSize > 0) { |
|
| 534 | + fread($stream, $headerSize); |
|
| 535 | + } |
|
| 536 | + |
|
| 537 | + // fast path, else the calculation for $lastChunkNr is bogus |
|
| 538 | + if ($size === 0) { |
|
| 539 | + return 0; |
|
| 540 | + } |
|
| 541 | + |
|
| 542 | + $signed = (isset($header['signed']) && $header['signed'] === 'true') ? true : false; |
|
| 543 | + $unencryptedBlockSize = $encryptionModule->getUnencryptedBlockSize($signed); |
|
| 544 | + |
|
| 545 | + // calculate last chunk nr |
|
| 546 | + // next highest is end of chunks, one subtracted is last one |
|
| 547 | + // we have to read the last chunk, we can't just calculate it (because of padding etc) |
|
| 548 | + |
|
| 549 | + $lastChunkNr = ceil($size/ $blockSize)-1; |
|
| 550 | + // calculate last chunk position |
|
| 551 | + $lastChunkPos = ($lastChunkNr * $blockSize); |
|
| 552 | + // try to fseek to the last chunk, if it fails we have to read the whole file |
|
| 553 | + if (@fseek($stream, $lastChunkPos, SEEK_CUR) === 0) { |
|
| 554 | + $newUnencryptedSize += $lastChunkNr * $unencryptedBlockSize; |
|
| 555 | + } |
|
| 556 | + |
|
| 557 | + $lastChunkContentEncrypted=''; |
|
| 558 | + $count = $blockSize; |
|
| 559 | + |
|
| 560 | + while ($count > 0) { |
|
| 561 | + $data=fread($stream, $blockSize); |
|
| 562 | + $count=strlen($data); |
|
| 563 | + $lastChunkContentEncrypted .= $data; |
|
| 564 | + if(strlen($lastChunkContentEncrypted) > $blockSize) { |
|
| 565 | + $newUnencryptedSize += $unencryptedBlockSize; |
|
| 566 | + $lastChunkContentEncrypted=substr($lastChunkContentEncrypted, $blockSize); |
|
| 567 | + } |
|
| 568 | + } |
|
| 569 | + |
|
| 570 | + fclose($stream); |
|
| 571 | + |
|
| 572 | + // we have to decrypt the last chunk to get it actual size |
|
| 573 | + $encryptionModule->begin($this->getFullPath($path), $this->uid, 'r', $header, []); |
|
| 574 | + $decryptedLastChunk = $encryptionModule->decrypt($lastChunkContentEncrypted, $lastChunkNr . 'end'); |
|
| 575 | + $decryptedLastChunk .= $encryptionModule->end($this->getFullPath($path), $lastChunkNr . 'end'); |
|
| 576 | + |
|
| 577 | + // calc the real file size with the size of the last chunk |
|
| 578 | + $newUnencryptedSize += strlen($decryptedLastChunk); |
|
| 579 | + |
|
| 580 | + $this->updateUnencryptedSize($this->getFullPath($path), $newUnencryptedSize); |
|
| 581 | + |
|
| 582 | + // write to cache if applicable |
|
| 583 | + $cache = $this->storage->getCache(); |
|
| 584 | + if ($cache) { |
|
| 585 | + $entry = $cache->get($path); |
|
| 586 | + $cache->update($entry['fileid'], ['size' => $newUnencryptedSize]); |
|
| 587 | + } |
|
| 588 | + |
|
| 589 | + return $newUnencryptedSize; |
|
| 590 | + } |
|
| 591 | + |
|
| 592 | + /** |
|
| 593 | + * @param Storage\IStorage $sourceStorage |
|
| 594 | + * @param string $sourceInternalPath |
|
| 595 | + * @param string $targetInternalPath |
|
| 596 | + * @param bool $preserveMtime |
|
| 597 | + * @return bool |
|
| 598 | + */ |
|
| 599 | + public function moveFromStorage(Storage\IStorage $sourceStorage, $sourceInternalPath, $targetInternalPath, $preserveMtime = true) { |
|
| 600 | + if ($sourceStorage === $this) { |
|
| 601 | + return $this->rename($sourceInternalPath, $targetInternalPath); |
|
| 602 | + } |
|
| 603 | + |
|
| 604 | + // TODO clean this up once the underlying moveFromStorage in OC\Files\Storage\Wrapper\Common is fixed: |
|
| 605 | + // - call $this->storage->moveFromStorage() instead of $this->copyBetweenStorage |
|
| 606 | + // - copy the file cache update from $this->copyBetweenStorage to this method |
|
| 607 | + // - copy the copyKeys() call from $this->copyBetweenStorage to this method |
|
| 608 | + // - remove $this->copyBetweenStorage |
|
| 609 | + |
|
| 610 | + if (!$sourceStorage->isDeletable($sourceInternalPath)) { |
|
| 611 | + return false; |
|
| 612 | + } |
|
| 613 | + |
|
| 614 | + $result = $this->copyBetweenStorage($sourceStorage, $sourceInternalPath, $targetInternalPath, $preserveMtime, true); |
|
| 615 | + if ($result) { |
|
| 616 | + if ($sourceStorage->is_dir($sourceInternalPath)) { |
|
| 617 | + $result &= $sourceStorage->rmdir($sourceInternalPath); |
|
| 618 | + } else { |
|
| 619 | + $result &= $sourceStorage->unlink($sourceInternalPath); |
|
| 620 | + } |
|
| 621 | + } |
|
| 622 | + return $result; |
|
| 623 | + } |
|
| 624 | + |
|
| 625 | + |
|
| 626 | + /** |
|
| 627 | + * @param Storage\IStorage $sourceStorage |
|
| 628 | + * @param string $sourceInternalPath |
|
| 629 | + * @param string $targetInternalPath |
|
| 630 | + * @param bool $preserveMtime |
|
| 631 | + * @param bool $isRename |
|
| 632 | + * @return bool |
|
| 633 | + */ |
|
| 634 | + public function copyFromStorage(Storage\IStorage $sourceStorage, $sourceInternalPath, $targetInternalPath, $preserveMtime = false, $isRename = false) { |
|
| 635 | + |
|
| 636 | + // TODO clean this up once the underlying moveFromStorage in OC\Files\Storage\Wrapper\Common is fixed: |
|
| 637 | + // - call $this->storage->copyFromStorage() instead of $this->copyBetweenStorage |
|
| 638 | + // - copy the file cache update from $this->copyBetweenStorage to this method |
|
| 639 | + // - copy the copyKeys() call from $this->copyBetweenStorage to this method |
|
| 640 | + // - remove $this->copyBetweenStorage |
|
| 641 | + |
|
| 642 | + return $this->copyBetweenStorage($sourceStorage, $sourceInternalPath, $targetInternalPath, $preserveMtime, $isRename); |
|
| 643 | + } |
|
| 644 | + |
|
| 645 | + /** |
|
| 646 | + * Update the encrypted cache version in the database |
|
| 647 | + * |
|
| 648 | + * @param Storage\IStorage $sourceStorage |
|
| 649 | + * @param string $sourceInternalPath |
|
| 650 | + * @param string $targetInternalPath |
|
| 651 | + * @param bool $isRename |
|
| 652 | + */ |
|
| 653 | + private function updateEncryptedVersion(Storage\IStorage $sourceStorage, $sourceInternalPath, $targetInternalPath, $isRename) { |
|
| 654 | + $isEncrypted = $this->encryptionManager->isEnabled() && $this->shouldEncrypt($targetInternalPath) ? 1 : 0; |
|
| 655 | + $cacheInformation = [ |
|
| 656 | + 'encrypted' => (bool)$isEncrypted, |
|
| 657 | + ]; |
|
| 658 | + if($isEncrypted === 1) { |
|
| 659 | + $encryptedVersion = $sourceStorage->getCache()->get($sourceInternalPath)['encryptedVersion']; |
|
| 660 | + |
|
| 661 | + // In case of a move operation from an unencrypted to an encrypted |
|
| 662 | + // storage the old encrypted version would stay with "0" while the |
|
| 663 | + // correct value would be "1". Thus we manually set the value to "1" |
|
| 664 | + // for those cases. |
|
| 665 | + // See also https://github.com/owncloud/core/issues/23078 |
|
| 666 | + if($encryptedVersion === 0) { |
|
| 667 | + $encryptedVersion = 1; |
|
| 668 | + } |
|
| 669 | + |
|
| 670 | + $cacheInformation['encryptedVersion'] = $encryptedVersion; |
|
| 671 | + } |
|
| 672 | + |
|
| 673 | + // in case of a rename we need to manipulate the source cache because |
|
| 674 | + // this information will be kept for the new target |
|
| 675 | + if ($isRename) { |
|
| 676 | + $sourceStorage->getCache()->put($sourceInternalPath, $cacheInformation); |
|
| 677 | + } else { |
|
| 678 | + $this->getCache()->put($targetInternalPath, $cacheInformation); |
|
| 679 | + } |
|
| 680 | + } |
|
| 681 | + |
|
| 682 | + /** |
|
| 683 | + * copy file between two storages |
|
| 684 | + * |
|
| 685 | + * @param Storage\IStorage $sourceStorage |
|
| 686 | + * @param string $sourceInternalPath |
|
| 687 | + * @param string $targetInternalPath |
|
| 688 | + * @param bool $preserveMtime |
|
| 689 | + * @param bool $isRename |
|
| 690 | + * @return bool |
|
| 691 | + * @throws \Exception |
|
| 692 | + */ |
|
| 693 | + private function copyBetweenStorage(Storage\IStorage $sourceStorage, $sourceInternalPath, $targetInternalPath, $preserveMtime, $isRename) { |
|
| 694 | + |
|
| 695 | + // for versions we have nothing to do, because versions should always use the |
|
| 696 | + // key from the original file. Just create a 1:1 copy and done |
|
| 697 | + if ($this->isVersion($targetInternalPath) || |
|
| 698 | + $this->isVersion($sourceInternalPath)) { |
|
| 699 | + // remember that we try to create a version so that we can detect it during |
|
| 700 | + // fopen($sourceInternalPath) and by-pass the encryption in order to |
|
| 701 | + // create a 1:1 copy of the file |
|
| 702 | + $this->arrayCache->set('encryption_copy_version_' . $sourceInternalPath, true); |
|
| 703 | + $result = $this->storage->copyFromStorage($sourceStorage, $sourceInternalPath, $targetInternalPath); |
|
| 704 | + $this->arrayCache->remove('encryption_copy_version_' . $sourceInternalPath); |
|
| 705 | + if ($result) { |
|
| 706 | + $info = $this->getCache('', $sourceStorage)->get($sourceInternalPath); |
|
| 707 | + // make sure that we update the unencrypted size for the version |
|
| 708 | + if (isset($info['encrypted']) && $info['encrypted'] === true) { |
|
| 709 | + $this->updateUnencryptedSize( |
|
| 710 | + $this->getFullPath($targetInternalPath), |
|
| 711 | + $info['size'] |
|
| 712 | + ); |
|
| 713 | + } |
|
| 714 | + $this->updateEncryptedVersion($sourceStorage, $sourceInternalPath, $targetInternalPath, $isRename); |
|
| 715 | + } |
|
| 716 | + return $result; |
|
| 717 | + } |
|
| 718 | + |
|
| 719 | + // first copy the keys that we reuse the existing file key on the target location |
|
| 720 | + // and don't create a new one which would break versions for example. |
|
| 721 | + $mount = $this->mountManager->findByStorageId($sourceStorage->getId()); |
|
| 722 | + if (count($mount) === 1) { |
|
| 723 | + $mountPoint = $mount[0]->getMountPoint(); |
|
| 724 | + $source = $mountPoint . '/' . $sourceInternalPath; |
|
| 725 | + $target = $this->getFullPath($targetInternalPath); |
|
| 726 | + $this->copyKeys($source, $target); |
|
| 727 | + } else { |
|
| 728 | + $this->logger->error('Could not find mount point, can\'t keep encryption keys'); |
|
| 729 | + } |
|
| 730 | + |
|
| 731 | + if ($sourceStorage->is_dir($sourceInternalPath)) { |
|
| 732 | + $dh = $sourceStorage->opendir($sourceInternalPath); |
|
| 733 | + $result = $this->mkdir($targetInternalPath); |
|
| 734 | + if (is_resource($dh)) { |
|
| 735 | + while ($result and ($file = readdir($dh)) !== false) { |
|
| 736 | + if (!Filesystem::isIgnoredDir($file)) { |
|
| 737 | + $result &= $this->copyFromStorage($sourceStorage, $sourceInternalPath . '/' . $file, $targetInternalPath . '/' . $file, false, $isRename); |
|
| 738 | + } |
|
| 739 | + } |
|
| 740 | + } |
|
| 741 | + } else { |
|
| 742 | + try { |
|
| 743 | + $source = $sourceStorage->fopen($sourceInternalPath, 'r'); |
|
| 744 | + $target = $this->fopen($targetInternalPath, 'w'); |
|
| 745 | + list(, $result) = \OC_Helper::streamCopy($source, $target); |
|
| 746 | + fclose($source); |
|
| 747 | + fclose($target); |
|
| 748 | + } catch (\Exception $e) { |
|
| 749 | + fclose($source); |
|
| 750 | + fclose($target); |
|
| 751 | + throw $e; |
|
| 752 | + } |
|
| 753 | + if($result) { |
|
| 754 | + if ($preserveMtime) { |
|
| 755 | + $this->touch($targetInternalPath, $sourceStorage->filemtime($sourceInternalPath)); |
|
| 756 | + } |
|
| 757 | + $this->updateEncryptedVersion($sourceStorage, $sourceInternalPath, $targetInternalPath, $isRename); |
|
| 758 | + } else { |
|
| 759 | + // delete partially written target file |
|
| 760 | + $this->unlink($targetInternalPath); |
|
| 761 | + // delete cache entry that was created by fopen |
|
| 762 | + $this->getCache()->remove($targetInternalPath); |
|
| 763 | + } |
|
| 764 | + } |
|
| 765 | + return (bool)$result; |
|
| 766 | + |
|
| 767 | + } |
|
| 768 | + |
|
| 769 | + /** |
|
| 770 | + * get the path to a local version of the file. |
|
| 771 | + * The local version of the file can be temporary and doesn't have to be persistent across requests |
|
| 772 | + * |
|
| 773 | + * @param string $path |
|
| 774 | + * @return string |
|
| 775 | + */ |
|
| 776 | + public function getLocalFile($path) { |
|
| 777 | + if ($this->encryptionManager->isEnabled()) { |
|
| 778 | + $cachedFile = $this->getCachedFile($path); |
|
| 779 | + if (is_string($cachedFile)) { |
|
| 780 | + return $cachedFile; |
|
| 781 | + } |
|
| 782 | + } |
|
| 783 | + return $this->storage->getLocalFile($path); |
|
| 784 | + } |
|
| 785 | + |
|
| 786 | + /** |
|
| 787 | + * Returns the wrapped storage's value for isLocal() |
|
| 788 | + * |
|
| 789 | + * @return bool wrapped storage's isLocal() value |
|
| 790 | + */ |
|
| 791 | + public function isLocal() { |
|
| 792 | + if ($this->encryptionManager->isEnabled()) { |
|
| 793 | + return false; |
|
| 794 | + } |
|
| 795 | + return $this->storage->isLocal(); |
|
| 796 | + } |
|
| 797 | + |
|
| 798 | + /** |
|
| 799 | + * see http://php.net/manual/en/function.stat.php |
|
| 800 | + * only the following keys are required in the result: size and mtime |
|
| 801 | + * |
|
| 802 | + * @param string $path |
|
| 803 | + * @return array |
|
| 804 | + */ |
|
| 805 | + public function stat($path) { |
|
| 806 | + $stat = $this->storage->stat($path); |
|
| 807 | + $fileSize = $this->filesize($path); |
|
| 808 | + $stat['size'] = $fileSize; |
|
| 809 | + $stat[7] = $fileSize; |
|
| 810 | + return $stat; |
|
| 811 | + } |
|
| 812 | + |
|
| 813 | + /** |
|
| 814 | + * see http://php.net/manual/en/function.hash.php |
|
| 815 | + * |
|
| 816 | + * @param string $type |
|
| 817 | + * @param string $path |
|
| 818 | + * @param bool $raw |
|
| 819 | + * @return string |
|
| 820 | + */ |
|
| 821 | + public function hash($type, $path, $raw = false) { |
|
| 822 | + $fh = $this->fopen($path, 'rb'); |
|
| 823 | + $ctx = hash_init($type); |
|
| 824 | + hash_update_stream($ctx, $fh); |
|
| 825 | + fclose($fh); |
|
| 826 | + return hash_final($ctx, $raw); |
|
| 827 | + } |
|
| 828 | + |
|
| 829 | + /** |
|
| 830 | + * return full path, including mount point |
|
| 831 | + * |
|
| 832 | + * @param string $path relative to mount point |
|
| 833 | + * @return string full path including mount point |
|
| 834 | + */ |
|
| 835 | + protected function getFullPath($path) { |
|
| 836 | + return Filesystem::normalizePath($this->mountPoint . '/' . $path); |
|
| 837 | + } |
|
| 838 | + |
|
| 839 | + /** |
|
| 840 | + * read first block of encrypted file, typically this will contain the |
|
| 841 | + * encryption header |
|
| 842 | + * |
|
| 843 | + * @param string $path |
|
| 844 | + * @return string |
|
| 845 | + */ |
|
| 846 | + protected function readFirstBlock($path) { |
|
| 847 | + $firstBlock = ''; |
|
| 848 | + if ($this->storage->file_exists($path)) { |
|
| 849 | + $handle = $this->storage->fopen($path, 'r'); |
|
| 850 | + $firstBlock = fread($handle, $this->util->getHeaderSize()); |
|
| 851 | + fclose($handle); |
|
| 852 | + } |
|
| 853 | + return $firstBlock; |
|
| 854 | + } |
|
| 855 | + |
|
| 856 | + /** |
|
| 857 | + * return header size of given file |
|
| 858 | + * |
|
| 859 | + * @param string $path |
|
| 860 | + * @return int |
|
| 861 | + */ |
|
| 862 | + protected function getHeaderSize($path) { |
|
| 863 | + $headerSize = 0; |
|
| 864 | + $realFile = $this->util->stripPartialFileExtension($path); |
|
| 865 | + if ($this->storage->file_exists($realFile)) { |
|
| 866 | + $path = $realFile; |
|
| 867 | + } |
|
| 868 | + $firstBlock = $this->readFirstBlock($path); |
|
| 869 | + |
|
| 870 | + if (substr($firstBlock, 0, strlen(Util::HEADER_START)) === Util::HEADER_START) { |
|
| 871 | + $headerSize = $this->util->getHeaderSize(); |
|
| 872 | + } |
|
| 873 | + |
|
| 874 | + return $headerSize; |
|
| 875 | + } |
|
| 876 | + |
|
| 877 | + /** |
|
| 878 | + * parse raw header to array |
|
| 879 | + * |
|
| 880 | + * @param string $rawHeader |
|
| 881 | + * @return array |
|
| 882 | + */ |
|
| 883 | + protected function parseRawHeader($rawHeader) { |
|
| 884 | + $result = array(); |
|
| 885 | + if (substr($rawHeader, 0, strlen(Util::HEADER_START)) === Util::HEADER_START) { |
|
| 886 | + $header = $rawHeader; |
|
| 887 | + $endAt = strpos($header, Util::HEADER_END); |
|
| 888 | + if ($endAt !== false) { |
|
| 889 | + $header = substr($header, 0, $endAt + strlen(Util::HEADER_END)); |
|
| 890 | + |
|
| 891 | + // +1 to not start with an ':' which would result in empty element at the beginning |
|
| 892 | + $exploded = explode(':', substr($header, strlen(Util::HEADER_START)+1)); |
|
| 893 | + |
|
| 894 | + $element = array_shift($exploded); |
|
| 895 | + while ($element !== Util::HEADER_END) { |
|
| 896 | + $result[$element] = array_shift($exploded); |
|
| 897 | + $element = array_shift($exploded); |
|
| 898 | + } |
|
| 899 | + } |
|
| 900 | + } |
|
| 901 | + |
|
| 902 | + return $result; |
|
| 903 | + } |
|
| 904 | + |
|
| 905 | + /** |
|
| 906 | + * read header from file |
|
| 907 | + * |
|
| 908 | + * @param string $path |
|
| 909 | + * @return array |
|
| 910 | + */ |
|
| 911 | + protected function getHeader($path) { |
|
| 912 | + $realFile = $this->util->stripPartialFileExtension($path); |
|
| 913 | + $exists = $this->storage->file_exists($realFile); |
|
| 914 | + if ($exists) { |
|
| 915 | + $path = $realFile; |
|
| 916 | + } |
|
| 917 | + |
|
| 918 | + $firstBlock = $this->readFirstBlock($path); |
|
| 919 | + $result = $this->parseRawHeader($firstBlock); |
|
| 920 | + |
|
| 921 | + // if the header doesn't contain a encryption module we check if it is a |
|
| 922 | + // legacy file. If true, we add the default encryption module |
|
| 923 | + if (!isset($result[Util::HEADER_ENCRYPTION_MODULE_KEY])) { |
|
| 924 | + if (!empty($result)) { |
|
| 925 | + $result[Util::HEADER_ENCRYPTION_MODULE_KEY] = 'OC_DEFAULT_MODULE'; |
|
| 926 | + } else if ($exists) { |
|
| 927 | + // if the header was empty we have to check first if it is a encrypted file at all |
|
| 928 | + // We would do query to filecache only if we know that entry in filecache exists |
|
| 929 | + $info = $this->getCache()->get($path); |
|
| 930 | + if (isset($info['encrypted']) && $info['encrypted'] === true) { |
|
| 931 | + $result[Util::HEADER_ENCRYPTION_MODULE_KEY] = 'OC_DEFAULT_MODULE'; |
|
| 932 | + } |
|
| 933 | + } |
|
| 934 | + } |
|
| 935 | + |
|
| 936 | + return $result; |
|
| 937 | + } |
|
| 938 | + |
|
| 939 | + /** |
|
| 940 | + * read encryption module needed to read/write the file located at $path |
|
| 941 | + * |
|
| 942 | + * @param string $path |
|
| 943 | + * @return null|\OCP\Encryption\IEncryptionModule |
|
| 944 | + * @throws ModuleDoesNotExistsException |
|
| 945 | + * @throws \Exception |
|
| 946 | + */ |
|
| 947 | + protected function getEncryptionModule($path) { |
|
| 948 | + $encryptionModule = null; |
|
| 949 | + $header = $this->getHeader($path); |
|
| 950 | + $encryptionModuleId = $this->util->getEncryptionModuleId($header); |
|
| 951 | + if (!empty($encryptionModuleId)) { |
|
| 952 | + try { |
|
| 953 | + $encryptionModule = $this->encryptionManager->getEncryptionModule($encryptionModuleId); |
|
| 954 | + } catch (ModuleDoesNotExistsException $e) { |
|
| 955 | + $this->logger->critical('Encryption module defined in "' . $path . '" not loaded!'); |
|
| 956 | + throw $e; |
|
| 957 | + } |
|
| 958 | + } |
|
| 959 | + |
|
| 960 | + return $encryptionModule; |
|
| 961 | + } |
|
| 962 | + |
|
| 963 | + /** |
|
| 964 | + * @param string $path |
|
| 965 | + * @param int $unencryptedSize |
|
| 966 | + */ |
|
| 967 | + public function updateUnencryptedSize($path, $unencryptedSize) { |
|
| 968 | + $this->unencryptedSize[$path] = $unencryptedSize; |
|
| 969 | + } |
|
| 970 | + |
|
| 971 | + /** |
|
| 972 | + * copy keys to new location |
|
| 973 | + * |
|
| 974 | + * @param string $source path relative to data/ |
|
| 975 | + * @param string $target path relative to data/ |
|
| 976 | + * @return bool |
|
| 977 | + */ |
|
| 978 | + protected function copyKeys($source, $target) { |
|
| 979 | + if (!$this->util->isExcluded($source)) { |
|
| 980 | + return $this->keyStorage->copyKeys($source, $target); |
|
| 981 | + } |
|
| 982 | + |
|
| 983 | + return false; |
|
| 984 | + } |
|
| 985 | + |
|
| 986 | + /** |
|
| 987 | + * check if path points to a files version |
|
| 988 | + * |
|
| 989 | + * @param $path |
|
| 990 | + * @return bool |
|
| 991 | + */ |
|
| 992 | + protected function isVersion($path) { |
|
| 993 | + $normalized = Filesystem::normalizePath($path); |
|
| 994 | + return substr($normalized, 0, strlen('/files_versions/')) === '/files_versions/'; |
|
| 995 | + } |
|
| 996 | + |
|
| 997 | + /** |
|
| 998 | + * check if the given storage should be encrypted or not |
|
| 999 | + * |
|
| 1000 | + * @param $path |
|
| 1001 | + * @return bool |
|
| 1002 | + */ |
|
| 1003 | + protected function shouldEncrypt($path) { |
|
| 1004 | + $fullPath = $this->getFullPath($path); |
|
| 1005 | + $mountPointConfig = $this->mount->getOption('encrypt', true); |
|
| 1006 | + if ($mountPointConfig === false) { |
|
| 1007 | + return false; |
|
| 1008 | + } |
|
| 1009 | + |
|
| 1010 | + try { |
|
| 1011 | + $encryptionModule = $this->getEncryptionModule($fullPath); |
|
| 1012 | + } catch (ModuleDoesNotExistsException $e) { |
|
| 1013 | + return false; |
|
| 1014 | + } |
|
| 1015 | + |
|
| 1016 | + if ($encryptionModule === null) { |
|
| 1017 | + $encryptionModule = $this->encryptionManager->getEncryptionModule(); |
|
| 1018 | + } |
|
| 1019 | + |
|
| 1020 | + return $encryptionModule->shouldEncrypt($fullPath); |
|
| 1021 | + |
|
| 1022 | + } |
|
| 1023 | 1023 | |
| 1024 | 1024 | } |
@@ -368,8 +368,8 @@ discard block |
||
| 368 | 368 | // check if the file is stored in the array cache, this means that we |
| 369 | 369 | // copy a file over to the versions folder, in this case we don't want to |
| 370 | 370 | // decrypt it |
| 371 | - if ($this->arrayCache->hasKey('encryption_copy_version_' . $path)) { |
|
| 372 | - $this->arrayCache->remove('encryption_copy_version_' . $path); |
|
| 371 | + if ($this->arrayCache->hasKey('encryption_copy_version_'.$path)) { |
|
| 372 | + $this->arrayCache->remove('encryption_copy_version_'.$path); |
|
| 373 | 373 | return $this->storage->fopen($path, $mode); |
| 374 | 374 | } |
| 375 | 375 | |
@@ -439,8 +439,8 @@ discard block |
||
| 439 | 439 | } |
| 440 | 440 | } |
| 441 | 441 | } catch (ModuleDoesNotExistsException $e) { |
| 442 | - $this->logger->warning('Encryption module "' . $encryptionModuleId . |
|
| 443 | - '" not found, file will be stored unencrypted (' . $e->getMessage() . ')'); |
|
| 442 | + $this->logger->warning('Encryption module "'.$encryptionModuleId. |
|
| 443 | + '" not found, file will be stored unencrypted ('.$e->getMessage().')'); |
|
| 444 | 444 | } |
| 445 | 445 | |
| 446 | 446 | // encryption disabled on write of new file and write to existing unencrypted file -> don't encrypt |
@@ -492,7 +492,7 @@ discard block |
||
| 492 | 492 | try { |
| 493 | 493 | $result = $this->fixUnencryptedSize($path, $size, $unencryptedSize); |
| 494 | 494 | } catch (\Exception $e) { |
| 495 | - $this->logger->error('Couldn\'t re-calculate unencrypted size for '. $path); |
|
| 495 | + $this->logger->error('Couldn\'t re-calculate unencrypted size for '.$path); |
|
| 496 | 496 | $this->logger->logException($e); |
| 497 | 497 | } |
| 498 | 498 | unset($this->fixUnencryptedSizeOf[$this->getFullPath($path)]); |
@@ -521,7 +521,7 @@ discard block |
||
| 521 | 521 | |
| 522 | 522 | // if we couldn't open the file we return the old unencrypted size |
| 523 | 523 | if (!is_resource($stream)) { |
| 524 | - $this->logger->error('Could not open ' . $path . '. Recalculation of unencrypted size aborted.'); |
|
| 524 | + $this->logger->error('Could not open '.$path.'. Recalculation of unencrypted size aborted.'); |
|
| 525 | 525 | return $unencryptedSize; |
| 526 | 526 | } |
| 527 | 527 | |
@@ -546,7 +546,7 @@ discard block |
||
| 546 | 546 | // next highest is end of chunks, one subtracted is last one |
| 547 | 547 | // we have to read the last chunk, we can't just calculate it (because of padding etc) |
| 548 | 548 | |
| 549 | - $lastChunkNr = ceil($size/ $blockSize)-1; |
|
| 549 | + $lastChunkNr = ceil($size / $blockSize) - 1; |
|
| 550 | 550 | // calculate last chunk position |
| 551 | 551 | $lastChunkPos = ($lastChunkNr * $blockSize); |
| 552 | 552 | // try to fseek to the last chunk, if it fails we have to read the whole file |
@@ -554,16 +554,16 @@ discard block |
||
| 554 | 554 | $newUnencryptedSize += $lastChunkNr * $unencryptedBlockSize; |
| 555 | 555 | } |
| 556 | 556 | |
| 557 | - $lastChunkContentEncrypted=''; |
|
| 557 | + $lastChunkContentEncrypted = ''; |
|
| 558 | 558 | $count = $blockSize; |
| 559 | 559 | |
| 560 | 560 | while ($count > 0) { |
| 561 | - $data=fread($stream, $blockSize); |
|
| 562 | - $count=strlen($data); |
|
| 561 | + $data = fread($stream, $blockSize); |
|
| 562 | + $count = strlen($data); |
|
| 563 | 563 | $lastChunkContentEncrypted .= $data; |
| 564 | - if(strlen($lastChunkContentEncrypted) > $blockSize) { |
|
| 564 | + if (strlen($lastChunkContentEncrypted) > $blockSize) { |
|
| 565 | 565 | $newUnencryptedSize += $unencryptedBlockSize; |
| 566 | - $lastChunkContentEncrypted=substr($lastChunkContentEncrypted, $blockSize); |
|
| 566 | + $lastChunkContentEncrypted = substr($lastChunkContentEncrypted, $blockSize); |
|
| 567 | 567 | } |
| 568 | 568 | } |
| 569 | 569 | |
@@ -571,8 +571,8 @@ discard block |
||
| 571 | 571 | |
| 572 | 572 | // we have to decrypt the last chunk to get it actual size |
| 573 | 573 | $encryptionModule->begin($this->getFullPath($path), $this->uid, 'r', $header, []); |
| 574 | - $decryptedLastChunk = $encryptionModule->decrypt($lastChunkContentEncrypted, $lastChunkNr . 'end'); |
|
| 575 | - $decryptedLastChunk .= $encryptionModule->end($this->getFullPath($path), $lastChunkNr . 'end'); |
|
| 574 | + $decryptedLastChunk = $encryptionModule->decrypt($lastChunkContentEncrypted, $lastChunkNr.'end'); |
|
| 575 | + $decryptedLastChunk .= $encryptionModule->end($this->getFullPath($path), $lastChunkNr.'end'); |
|
| 576 | 576 | |
| 577 | 577 | // calc the real file size with the size of the last chunk |
| 578 | 578 | $newUnencryptedSize += strlen($decryptedLastChunk); |
@@ -653,9 +653,9 @@ discard block |
||
| 653 | 653 | private function updateEncryptedVersion(Storage\IStorage $sourceStorage, $sourceInternalPath, $targetInternalPath, $isRename) { |
| 654 | 654 | $isEncrypted = $this->encryptionManager->isEnabled() && $this->shouldEncrypt($targetInternalPath) ? 1 : 0; |
| 655 | 655 | $cacheInformation = [ |
| 656 | - 'encrypted' => (bool)$isEncrypted, |
|
| 656 | + 'encrypted' => (bool) $isEncrypted, |
|
| 657 | 657 | ]; |
| 658 | - if($isEncrypted === 1) { |
|
| 658 | + if ($isEncrypted === 1) { |
|
| 659 | 659 | $encryptedVersion = $sourceStorage->getCache()->get($sourceInternalPath)['encryptedVersion']; |
| 660 | 660 | |
| 661 | 661 | // In case of a move operation from an unencrypted to an encrypted |
@@ -663,7 +663,7 @@ discard block |
||
| 663 | 663 | // correct value would be "1". Thus we manually set the value to "1" |
| 664 | 664 | // for those cases. |
| 665 | 665 | // See also https://github.com/owncloud/core/issues/23078 |
| 666 | - if($encryptedVersion === 0) { |
|
| 666 | + if ($encryptedVersion === 0) { |
|
| 667 | 667 | $encryptedVersion = 1; |
| 668 | 668 | } |
| 669 | 669 | |
@@ -699,9 +699,9 @@ discard block |
||
| 699 | 699 | // remember that we try to create a version so that we can detect it during |
| 700 | 700 | // fopen($sourceInternalPath) and by-pass the encryption in order to |
| 701 | 701 | // create a 1:1 copy of the file |
| 702 | - $this->arrayCache->set('encryption_copy_version_' . $sourceInternalPath, true); |
|
| 702 | + $this->arrayCache->set('encryption_copy_version_'.$sourceInternalPath, true); |
|
| 703 | 703 | $result = $this->storage->copyFromStorage($sourceStorage, $sourceInternalPath, $targetInternalPath); |
| 704 | - $this->arrayCache->remove('encryption_copy_version_' . $sourceInternalPath); |
|
| 704 | + $this->arrayCache->remove('encryption_copy_version_'.$sourceInternalPath); |
|
| 705 | 705 | if ($result) { |
| 706 | 706 | $info = $this->getCache('', $sourceStorage)->get($sourceInternalPath); |
| 707 | 707 | // make sure that we update the unencrypted size for the version |
@@ -721,7 +721,7 @@ discard block |
||
| 721 | 721 | $mount = $this->mountManager->findByStorageId($sourceStorage->getId()); |
| 722 | 722 | if (count($mount) === 1) { |
| 723 | 723 | $mountPoint = $mount[0]->getMountPoint(); |
| 724 | - $source = $mountPoint . '/' . $sourceInternalPath; |
|
| 724 | + $source = $mountPoint.'/'.$sourceInternalPath; |
|
| 725 | 725 | $target = $this->getFullPath($targetInternalPath); |
| 726 | 726 | $this->copyKeys($source, $target); |
| 727 | 727 | } else { |
@@ -734,7 +734,7 @@ discard block |
||
| 734 | 734 | if (is_resource($dh)) { |
| 735 | 735 | while ($result and ($file = readdir($dh)) !== false) { |
| 736 | 736 | if (!Filesystem::isIgnoredDir($file)) { |
| 737 | - $result &= $this->copyFromStorage($sourceStorage, $sourceInternalPath . '/' . $file, $targetInternalPath . '/' . $file, false, $isRename); |
|
| 737 | + $result &= $this->copyFromStorage($sourceStorage, $sourceInternalPath.'/'.$file, $targetInternalPath.'/'.$file, false, $isRename); |
|
| 738 | 738 | } |
| 739 | 739 | } |
| 740 | 740 | } |
@@ -750,7 +750,7 @@ discard block |
||
| 750 | 750 | fclose($target); |
| 751 | 751 | throw $e; |
| 752 | 752 | } |
| 753 | - if($result) { |
|
| 753 | + if ($result) { |
|
| 754 | 754 | if ($preserveMtime) { |
| 755 | 755 | $this->touch($targetInternalPath, $sourceStorage->filemtime($sourceInternalPath)); |
| 756 | 756 | } |
@@ -762,7 +762,7 @@ discard block |
||
| 762 | 762 | $this->getCache()->remove($targetInternalPath); |
| 763 | 763 | } |
| 764 | 764 | } |
| 765 | - return (bool)$result; |
|
| 765 | + return (bool) $result; |
|
| 766 | 766 | |
| 767 | 767 | } |
| 768 | 768 | |
@@ -833,7 +833,7 @@ discard block |
||
| 833 | 833 | * @return string full path including mount point |
| 834 | 834 | */ |
| 835 | 835 | protected function getFullPath($path) { |
| 836 | - return Filesystem::normalizePath($this->mountPoint . '/' . $path); |
|
| 836 | + return Filesystem::normalizePath($this->mountPoint.'/'.$path); |
|
| 837 | 837 | } |
| 838 | 838 | |
| 839 | 839 | /** |
@@ -889,7 +889,7 @@ discard block |
||
| 889 | 889 | $header = substr($header, 0, $endAt + strlen(Util::HEADER_END)); |
| 890 | 890 | |
| 891 | 891 | // +1 to not start with an ':' which would result in empty element at the beginning |
| 892 | - $exploded = explode(':', substr($header, strlen(Util::HEADER_START)+1)); |
|
| 892 | + $exploded = explode(':', substr($header, strlen(Util::HEADER_START) + 1)); |
|
| 893 | 893 | |
| 894 | 894 | $element = array_shift($exploded); |
| 895 | 895 | while ($element !== Util::HEADER_END) { |
@@ -952,7 +952,7 @@ discard block |
||
| 952 | 952 | try { |
| 953 | 953 | $encryptionModule = $this->encryptionManager->getEncryptionModule($encryptionModuleId); |
| 954 | 954 | } catch (ModuleDoesNotExistsException $e) { |
| 955 | - $this->logger->critical('Encryption module defined in "' . $path . '" not loaded!'); |
|
| 955 | + $this->logger->critical('Encryption module defined in "'.$path.'" not loaded!'); |
|
| 956 | 956 | throw $e; |
| 957 | 957 | } |
| 958 | 958 | } |
@@ -162,6 +162,9 @@ discard block |
||
| 162 | 162 | return true; |
| 163 | 163 | } |
| 164 | 164 | |
| 165 | + /** |
|
| 166 | + * @param string $path |
|
| 167 | + */ |
|
| 165 | 168 | private function rmObjects($path) { |
| 166 | 169 | $children = $this->getCache()->getFolderContents($path); |
| 167 | 170 | foreach ($children as $child) { |
@@ -364,6 +367,9 @@ discard block |
||
| 364 | 367 | return true; |
| 365 | 368 | } |
| 366 | 369 | |
| 370 | + /** |
|
| 371 | + * @param string $path |
|
| 372 | + */ |
|
| 367 | 373 | public function writeBack($tmpFile, $path) { |
| 368 | 374 | $stat = $this->stat($path); |
| 369 | 375 | if (empty($stat)) { |
@@ -31,390 +31,390 @@ |
||
| 31 | 31 | use OCP\Files\ObjectStore\IObjectStore; |
| 32 | 32 | |
| 33 | 33 | class ObjectStoreStorage extends \OC\Files\Storage\Common { |
| 34 | - /** |
|
| 35 | - * @var \OCP\Files\ObjectStore\IObjectStore $objectStore |
|
| 36 | - */ |
|
| 37 | - protected $objectStore; |
|
| 38 | - /** |
|
| 39 | - * @var string $id |
|
| 40 | - */ |
|
| 41 | - protected $id; |
|
| 42 | - /** |
|
| 43 | - * @var \OC\User\User $user |
|
| 44 | - */ |
|
| 45 | - protected $user; |
|
| 46 | - |
|
| 47 | - private $objectPrefix = 'urn:oid:'; |
|
| 48 | - |
|
| 49 | - private $logger; |
|
| 50 | - |
|
| 51 | - public function __construct($params) { |
|
| 52 | - if (isset($params['objectstore']) && $params['objectstore'] instanceof IObjectStore) { |
|
| 53 | - $this->objectStore = $params['objectstore']; |
|
| 54 | - } else { |
|
| 55 | - throw new \Exception('missing IObjectStore instance'); |
|
| 56 | - } |
|
| 57 | - if (isset($params['storageid'])) { |
|
| 58 | - $this->id = 'object::store:' . $params['storageid']; |
|
| 59 | - } else { |
|
| 60 | - $this->id = 'object::store:' . $this->objectStore->getStorageId(); |
|
| 61 | - } |
|
| 62 | - if (isset($params['objectPrefix'])) { |
|
| 63 | - $this->objectPrefix = $params['objectPrefix']; |
|
| 64 | - } |
|
| 65 | - //initialize cache with root directory in cache |
|
| 66 | - if (!$this->is_dir('/')) { |
|
| 67 | - $this->mkdir('/'); |
|
| 68 | - } |
|
| 69 | - |
|
| 70 | - $this->logger = \OC::$server->getLogger(); |
|
| 71 | - } |
|
| 72 | - |
|
| 73 | - public function mkdir($path) { |
|
| 74 | - $path = $this->normalizePath($path); |
|
| 75 | - |
|
| 76 | - if ($this->file_exists($path)) { |
|
| 77 | - return false; |
|
| 78 | - } |
|
| 79 | - |
|
| 80 | - $mTime = time(); |
|
| 81 | - $data = [ |
|
| 82 | - 'mimetype' => 'httpd/unix-directory', |
|
| 83 | - 'size' => 0, |
|
| 84 | - 'mtime' => $mTime, |
|
| 85 | - 'storage_mtime' => $mTime, |
|
| 86 | - 'permissions' => \OCP\Constants::PERMISSION_ALL, |
|
| 87 | - ]; |
|
| 88 | - if ($path === '') { |
|
| 89 | - //create root on the fly |
|
| 90 | - $data['etag'] = $this->getETag(''); |
|
| 91 | - $this->getCache()->put('', $data); |
|
| 92 | - return true; |
|
| 93 | - } else { |
|
| 94 | - // if parent does not exist, create it |
|
| 95 | - $parent = $this->normalizePath(dirname($path)); |
|
| 96 | - $parentType = $this->filetype($parent); |
|
| 97 | - if ($parentType === false) { |
|
| 98 | - if (!$this->mkdir($parent)) { |
|
| 99 | - // something went wrong |
|
| 100 | - return false; |
|
| 101 | - } |
|
| 102 | - } else if ($parentType === 'file') { |
|
| 103 | - // parent is a file |
|
| 104 | - return false; |
|
| 105 | - } |
|
| 106 | - // finally create the new dir |
|
| 107 | - $mTime = time(); // update mtime |
|
| 108 | - $data['mtime'] = $mTime; |
|
| 109 | - $data['storage_mtime'] = $mTime; |
|
| 110 | - $data['etag'] = $this->getETag($path); |
|
| 111 | - $this->getCache()->put($path, $data); |
|
| 112 | - return true; |
|
| 113 | - } |
|
| 114 | - } |
|
| 115 | - |
|
| 116 | - /** |
|
| 117 | - * @param string $path |
|
| 118 | - * @return string |
|
| 119 | - */ |
|
| 120 | - private function normalizePath($path) { |
|
| 121 | - $path = trim($path, '/'); |
|
| 122 | - //FIXME why do we sometimes get a path like 'files//username'? |
|
| 123 | - $path = str_replace('//', '/', $path); |
|
| 124 | - |
|
| 125 | - // dirname('/folder') returns '.' but internally (in the cache) we store the root as '' |
|
| 126 | - if (!$path || $path === '.') { |
|
| 127 | - $path = ''; |
|
| 128 | - } |
|
| 129 | - |
|
| 130 | - return $path; |
|
| 131 | - } |
|
| 132 | - |
|
| 133 | - /** |
|
| 134 | - * Object Stores use a NoopScanner because metadata is directly stored in |
|
| 135 | - * the file cache and cannot really scan the filesystem. The storage passed in is not used anywhere. |
|
| 136 | - * |
|
| 137 | - * @param string $path |
|
| 138 | - * @param \OC\Files\Storage\Storage (optional) the storage to pass to the scanner |
|
| 139 | - * @return \OC\Files\ObjectStore\NoopScanner |
|
| 140 | - */ |
|
| 141 | - public function getScanner($path = '', $storage = null) { |
|
| 142 | - if (!$storage) { |
|
| 143 | - $storage = $this; |
|
| 144 | - } |
|
| 145 | - if (!isset($this->scanner)) { |
|
| 146 | - $this->scanner = new NoopScanner($storage); |
|
| 147 | - } |
|
| 148 | - return $this->scanner; |
|
| 149 | - } |
|
| 150 | - |
|
| 151 | - public function getId() { |
|
| 152 | - return $this->id; |
|
| 153 | - } |
|
| 154 | - |
|
| 155 | - public function rmdir($path) { |
|
| 156 | - $path = $this->normalizePath($path); |
|
| 157 | - |
|
| 158 | - if (!$this->is_dir($path)) { |
|
| 159 | - return false; |
|
| 160 | - } |
|
| 161 | - |
|
| 162 | - $this->rmObjects($path); |
|
| 163 | - |
|
| 164 | - $this->getCache()->remove($path); |
|
| 165 | - |
|
| 166 | - return true; |
|
| 167 | - } |
|
| 168 | - |
|
| 169 | - private function rmObjects($path) { |
|
| 170 | - $children = $this->getCache()->getFolderContents($path); |
|
| 171 | - foreach ($children as $child) { |
|
| 172 | - if ($child['mimetype'] === 'httpd/unix-directory') { |
|
| 173 | - $this->rmObjects($child['path']); |
|
| 174 | - } else { |
|
| 175 | - $this->unlink($child['path']); |
|
| 176 | - } |
|
| 177 | - } |
|
| 178 | - } |
|
| 179 | - |
|
| 180 | - public function unlink($path) { |
|
| 181 | - $path = $this->normalizePath($path); |
|
| 182 | - $stat = $this->stat($path); |
|
| 183 | - |
|
| 184 | - if ($stat && isset($stat['fileid'])) { |
|
| 185 | - if ($stat['mimetype'] === 'httpd/unix-directory') { |
|
| 186 | - return $this->rmdir($path); |
|
| 187 | - } |
|
| 188 | - try { |
|
| 189 | - $this->objectStore->deleteObject($this->getURN($stat['fileid'])); |
|
| 190 | - } catch (\Exception $ex) { |
|
| 191 | - if ($ex->getCode() !== 404) { |
|
| 192 | - $this->logger->logException($ex, [ |
|
| 193 | - 'app' => 'objectstore', |
|
| 194 | - 'message' => 'Could not delete object ' . $this->getURN($stat['fileid']) . ' for ' . $path, |
|
| 195 | - ]); |
|
| 196 | - return false; |
|
| 197 | - } else { |
|
| 198 | - //removing from cache is ok as it does not exist in the objectstore anyway |
|
| 199 | - } |
|
| 200 | - } |
|
| 201 | - $this->getCache()->remove($path); |
|
| 202 | - return true; |
|
| 203 | - } |
|
| 204 | - return false; |
|
| 205 | - } |
|
| 206 | - |
|
| 207 | - public function stat($path) { |
|
| 208 | - $path = $this->normalizePath($path); |
|
| 209 | - $cacheEntry = $this->getCache()->get($path); |
|
| 210 | - if ($cacheEntry instanceof CacheEntry) { |
|
| 211 | - return $cacheEntry->getData(); |
|
| 212 | - } else { |
|
| 213 | - return false; |
|
| 214 | - } |
|
| 215 | - } |
|
| 216 | - |
|
| 217 | - /** |
|
| 218 | - * Override this method if you need a different unique resource identifier for your object storage implementation. |
|
| 219 | - * The default implementations just appends the fileId to 'urn:oid:'. Make sure the URN is unique over all users. |
|
| 220 | - * You may need a mapping table to store your URN if it cannot be generated from the fileid. |
|
| 221 | - * |
|
| 222 | - * @param int $fileId the fileid |
|
| 223 | - * @return null|string the unified resource name used to identify the object |
|
| 224 | - */ |
|
| 225 | - protected function getURN($fileId) { |
|
| 226 | - if (is_numeric($fileId)) { |
|
| 227 | - return $this->objectPrefix . $fileId; |
|
| 228 | - } |
|
| 229 | - return null; |
|
| 230 | - } |
|
| 231 | - |
|
| 232 | - public function opendir($path) { |
|
| 233 | - $path = $this->normalizePath($path); |
|
| 234 | - |
|
| 235 | - try { |
|
| 236 | - $files = array(); |
|
| 237 | - $folderContents = $this->getCache()->getFolderContents($path); |
|
| 238 | - foreach ($folderContents as $file) { |
|
| 239 | - $files[] = $file['name']; |
|
| 240 | - } |
|
| 241 | - |
|
| 242 | - return IteratorDirectory::wrap($files); |
|
| 243 | - } catch (\Exception $e) { |
|
| 244 | - $this->logger->logException($e); |
|
| 245 | - return false; |
|
| 246 | - } |
|
| 247 | - } |
|
| 248 | - |
|
| 249 | - public function filetype($path) { |
|
| 250 | - $path = $this->normalizePath($path); |
|
| 251 | - $stat = $this->stat($path); |
|
| 252 | - if ($stat) { |
|
| 253 | - if ($stat['mimetype'] === 'httpd/unix-directory') { |
|
| 254 | - return 'dir'; |
|
| 255 | - } |
|
| 256 | - return 'file'; |
|
| 257 | - } else { |
|
| 258 | - return false; |
|
| 259 | - } |
|
| 260 | - } |
|
| 261 | - |
|
| 262 | - public function fopen($path, $mode) { |
|
| 263 | - $path = $this->normalizePath($path); |
|
| 264 | - |
|
| 265 | - switch ($mode) { |
|
| 266 | - case 'r': |
|
| 267 | - case 'rb': |
|
| 268 | - $stat = $this->stat($path); |
|
| 269 | - if (is_array($stat)) { |
|
| 270 | - try { |
|
| 271 | - return $this->objectStore->readObject($this->getURN($stat['fileid'])); |
|
| 272 | - } catch (\Exception $ex) { |
|
| 273 | - $this->logger->logException($ex, [ |
|
| 274 | - 'app' => 'objectstore', |
|
| 275 | - 'message' => 'Count not get object ' . $this->getURN($stat['fileid']) . ' for file ' . $path, |
|
| 276 | - ]); |
|
| 277 | - return false; |
|
| 278 | - } |
|
| 279 | - } else { |
|
| 280 | - return false; |
|
| 281 | - } |
|
| 282 | - case 'w': |
|
| 283 | - case 'wb': |
|
| 284 | - case 'a': |
|
| 285 | - case 'ab': |
|
| 286 | - case 'r+': |
|
| 287 | - case 'w+': |
|
| 288 | - case 'wb+': |
|
| 289 | - case 'a+': |
|
| 290 | - case 'x': |
|
| 291 | - case 'x+': |
|
| 292 | - case 'c': |
|
| 293 | - case 'c+': |
|
| 294 | - if (strrpos($path, '.') !== false) { |
|
| 295 | - $ext = substr($path, strrpos($path, '.')); |
|
| 296 | - } else { |
|
| 297 | - $ext = ''; |
|
| 298 | - } |
|
| 299 | - $tmpFile = \OC::$server->getTempManager()->getTemporaryFile($ext); |
|
| 300 | - if ($this->file_exists($path)) { |
|
| 301 | - $source = $this->fopen($path, 'r'); |
|
| 302 | - file_put_contents($tmpFile, $source); |
|
| 303 | - } |
|
| 304 | - $handle = fopen($tmpFile, $mode); |
|
| 305 | - return CallbackWrapper::wrap($handle, null, null, function () use ($path, $tmpFile) { |
|
| 306 | - $this->writeBack($tmpFile, $path); |
|
| 307 | - }); |
|
| 308 | - } |
|
| 309 | - return false; |
|
| 310 | - } |
|
| 311 | - |
|
| 312 | - public function file_exists($path) { |
|
| 313 | - $path = $this->normalizePath($path); |
|
| 314 | - return (bool)$this->stat($path); |
|
| 315 | - } |
|
| 316 | - |
|
| 317 | - public function rename($source, $target) { |
|
| 318 | - $source = $this->normalizePath($source); |
|
| 319 | - $target = $this->normalizePath($target); |
|
| 320 | - $this->remove($target); |
|
| 321 | - $this->getCache()->move($source, $target); |
|
| 322 | - $this->touch(dirname($target)); |
|
| 323 | - return true; |
|
| 324 | - } |
|
| 325 | - |
|
| 326 | - public function getMimeType($path) { |
|
| 327 | - $path = $this->normalizePath($path); |
|
| 328 | - $stat = $this->stat($path); |
|
| 329 | - if (is_array($stat)) { |
|
| 330 | - return $stat['mimetype']; |
|
| 331 | - } else { |
|
| 332 | - return false; |
|
| 333 | - } |
|
| 334 | - } |
|
| 335 | - |
|
| 336 | - public function touch($path, $mtime = null) { |
|
| 337 | - if (is_null($mtime)) { |
|
| 338 | - $mtime = time(); |
|
| 339 | - } |
|
| 340 | - |
|
| 341 | - $path = $this->normalizePath($path); |
|
| 342 | - $dirName = dirname($path); |
|
| 343 | - $parentExists = $this->is_dir($dirName); |
|
| 344 | - if (!$parentExists) { |
|
| 345 | - return false; |
|
| 346 | - } |
|
| 347 | - |
|
| 348 | - $stat = $this->stat($path); |
|
| 349 | - if (is_array($stat)) { |
|
| 350 | - // update existing mtime in db |
|
| 351 | - $stat['mtime'] = $mtime; |
|
| 352 | - $this->getCache()->update($stat['fileid'], $stat); |
|
| 353 | - } else { |
|
| 354 | - $mimeType = \OC::$server->getMimeTypeDetector()->detectPath($path); |
|
| 355 | - // create new file |
|
| 356 | - $stat = array( |
|
| 357 | - 'etag' => $this->getETag($path), |
|
| 358 | - 'mimetype' => $mimeType, |
|
| 359 | - 'size' => 0, |
|
| 360 | - 'mtime' => $mtime, |
|
| 361 | - 'storage_mtime' => $mtime, |
|
| 362 | - 'permissions' => \OCP\Constants::PERMISSION_ALL - \OCP\Constants::PERMISSION_CREATE, |
|
| 363 | - ); |
|
| 364 | - $fileId = $this->getCache()->put($path, $stat); |
|
| 365 | - try { |
|
| 366 | - //read an empty file from memory |
|
| 367 | - $this->objectStore->writeObject($this->getURN($fileId), fopen('php://memory', 'r')); |
|
| 368 | - } catch (\Exception $ex) { |
|
| 369 | - $this->getCache()->remove($path); |
|
| 370 | - $this->logger->logException($ex, [ |
|
| 371 | - 'app' => 'objectstore', |
|
| 372 | - 'message' => 'Could not create object ' . $this->getURN($fileId) . ' for ' . $path, |
|
| 373 | - ]); |
|
| 374 | - return false; |
|
| 375 | - } |
|
| 376 | - } |
|
| 377 | - return true; |
|
| 378 | - } |
|
| 379 | - |
|
| 380 | - public function writeBack($tmpFile, $path) { |
|
| 381 | - $stat = $this->stat($path); |
|
| 382 | - if (empty($stat)) { |
|
| 383 | - // create new file |
|
| 384 | - $stat = array( |
|
| 385 | - 'permissions' => \OCP\Constants::PERMISSION_ALL - \OCP\Constants::PERMISSION_CREATE, |
|
| 386 | - ); |
|
| 387 | - } |
|
| 388 | - // update stat with new data |
|
| 389 | - $mTime = time(); |
|
| 390 | - $stat['size'] = filesize($tmpFile); |
|
| 391 | - $stat['mtime'] = $mTime; |
|
| 392 | - $stat['storage_mtime'] = $mTime; |
|
| 393 | - $stat['mimetype'] = \OC::$server->getMimeTypeDetector()->detect($tmpFile); |
|
| 394 | - $stat['etag'] = $this->getETag($path); |
|
| 395 | - |
|
| 396 | - $fileId = $this->getCache()->put($path, $stat); |
|
| 397 | - try { |
|
| 398 | - //upload to object storage |
|
| 399 | - $this->objectStore->writeObject($this->getURN($fileId), fopen($tmpFile, 'r')); |
|
| 400 | - } catch (\Exception $ex) { |
|
| 401 | - $this->getCache()->remove($path); |
|
| 402 | - $this->logger->logException($ex, [ |
|
| 403 | - 'app' => 'objectstore', |
|
| 404 | - 'message' => 'Could not create object ' . $this->getURN($fileId) . ' for ' . $path, |
|
| 405 | - ]); |
|
| 406 | - throw $ex; // make this bubble up |
|
| 407 | - } |
|
| 408 | - } |
|
| 409 | - |
|
| 410 | - /** |
|
| 411 | - * external changes are not supported, exclusive access to the object storage is assumed |
|
| 412 | - * |
|
| 413 | - * @param string $path |
|
| 414 | - * @param int $time |
|
| 415 | - * @return false |
|
| 416 | - */ |
|
| 417 | - public function hasUpdated($path, $time) { |
|
| 418 | - return false; |
|
| 419 | - } |
|
| 34 | + /** |
|
| 35 | + * @var \OCP\Files\ObjectStore\IObjectStore $objectStore |
|
| 36 | + */ |
|
| 37 | + protected $objectStore; |
|
| 38 | + /** |
|
| 39 | + * @var string $id |
|
| 40 | + */ |
|
| 41 | + protected $id; |
|
| 42 | + /** |
|
| 43 | + * @var \OC\User\User $user |
|
| 44 | + */ |
|
| 45 | + protected $user; |
|
| 46 | + |
|
| 47 | + private $objectPrefix = 'urn:oid:'; |
|
| 48 | + |
|
| 49 | + private $logger; |
|
| 50 | + |
|
| 51 | + public function __construct($params) { |
|
| 52 | + if (isset($params['objectstore']) && $params['objectstore'] instanceof IObjectStore) { |
|
| 53 | + $this->objectStore = $params['objectstore']; |
|
| 54 | + } else { |
|
| 55 | + throw new \Exception('missing IObjectStore instance'); |
|
| 56 | + } |
|
| 57 | + if (isset($params['storageid'])) { |
|
| 58 | + $this->id = 'object::store:' . $params['storageid']; |
|
| 59 | + } else { |
|
| 60 | + $this->id = 'object::store:' . $this->objectStore->getStorageId(); |
|
| 61 | + } |
|
| 62 | + if (isset($params['objectPrefix'])) { |
|
| 63 | + $this->objectPrefix = $params['objectPrefix']; |
|
| 64 | + } |
|
| 65 | + //initialize cache with root directory in cache |
|
| 66 | + if (!$this->is_dir('/')) { |
|
| 67 | + $this->mkdir('/'); |
|
| 68 | + } |
|
| 69 | + |
|
| 70 | + $this->logger = \OC::$server->getLogger(); |
|
| 71 | + } |
|
| 72 | + |
|
| 73 | + public function mkdir($path) { |
|
| 74 | + $path = $this->normalizePath($path); |
|
| 75 | + |
|
| 76 | + if ($this->file_exists($path)) { |
|
| 77 | + return false; |
|
| 78 | + } |
|
| 79 | + |
|
| 80 | + $mTime = time(); |
|
| 81 | + $data = [ |
|
| 82 | + 'mimetype' => 'httpd/unix-directory', |
|
| 83 | + 'size' => 0, |
|
| 84 | + 'mtime' => $mTime, |
|
| 85 | + 'storage_mtime' => $mTime, |
|
| 86 | + 'permissions' => \OCP\Constants::PERMISSION_ALL, |
|
| 87 | + ]; |
|
| 88 | + if ($path === '') { |
|
| 89 | + //create root on the fly |
|
| 90 | + $data['etag'] = $this->getETag(''); |
|
| 91 | + $this->getCache()->put('', $data); |
|
| 92 | + return true; |
|
| 93 | + } else { |
|
| 94 | + // if parent does not exist, create it |
|
| 95 | + $parent = $this->normalizePath(dirname($path)); |
|
| 96 | + $parentType = $this->filetype($parent); |
|
| 97 | + if ($parentType === false) { |
|
| 98 | + if (!$this->mkdir($parent)) { |
|
| 99 | + // something went wrong |
|
| 100 | + return false; |
|
| 101 | + } |
|
| 102 | + } else if ($parentType === 'file') { |
|
| 103 | + // parent is a file |
|
| 104 | + return false; |
|
| 105 | + } |
|
| 106 | + // finally create the new dir |
|
| 107 | + $mTime = time(); // update mtime |
|
| 108 | + $data['mtime'] = $mTime; |
|
| 109 | + $data['storage_mtime'] = $mTime; |
|
| 110 | + $data['etag'] = $this->getETag($path); |
|
| 111 | + $this->getCache()->put($path, $data); |
|
| 112 | + return true; |
|
| 113 | + } |
|
| 114 | + } |
|
| 115 | + |
|
| 116 | + /** |
|
| 117 | + * @param string $path |
|
| 118 | + * @return string |
|
| 119 | + */ |
|
| 120 | + private function normalizePath($path) { |
|
| 121 | + $path = trim($path, '/'); |
|
| 122 | + //FIXME why do we sometimes get a path like 'files//username'? |
|
| 123 | + $path = str_replace('//', '/', $path); |
|
| 124 | + |
|
| 125 | + // dirname('/folder') returns '.' but internally (in the cache) we store the root as '' |
|
| 126 | + if (!$path || $path === '.') { |
|
| 127 | + $path = ''; |
|
| 128 | + } |
|
| 129 | + |
|
| 130 | + return $path; |
|
| 131 | + } |
|
| 132 | + |
|
| 133 | + /** |
|
| 134 | + * Object Stores use a NoopScanner because metadata is directly stored in |
|
| 135 | + * the file cache and cannot really scan the filesystem. The storage passed in is not used anywhere. |
|
| 136 | + * |
|
| 137 | + * @param string $path |
|
| 138 | + * @param \OC\Files\Storage\Storage (optional) the storage to pass to the scanner |
|
| 139 | + * @return \OC\Files\ObjectStore\NoopScanner |
|
| 140 | + */ |
|
| 141 | + public function getScanner($path = '', $storage = null) { |
|
| 142 | + if (!$storage) { |
|
| 143 | + $storage = $this; |
|
| 144 | + } |
|
| 145 | + if (!isset($this->scanner)) { |
|
| 146 | + $this->scanner = new NoopScanner($storage); |
|
| 147 | + } |
|
| 148 | + return $this->scanner; |
|
| 149 | + } |
|
| 150 | + |
|
| 151 | + public function getId() { |
|
| 152 | + return $this->id; |
|
| 153 | + } |
|
| 154 | + |
|
| 155 | + public function rmdir($path) { |
|
| 156 | + $path = $this->normalizePath($path); |
|
| 157 | + |
|
| 158 | + if (!$this->is_dir($path)) { |
|
| 159 | + return false; |
|
| 160 | + } |
|
| 161 | + |
|
| 162 | + $this->rmObjects($path); |
|
| 163 | + |
|
| 164 | + $this->getCache()->remove($path); |
|
| 165 | + |
|
| 166 | + return true; |
|
| 167 | + } |
|
| 168 | + |
|
| 169 | + private function rmObjects($path) { |
|
| 170 | + $children = $this->getCache()->getFolderContents($path); |
|
| 171 | + foreach ($children as $child) { |
|
| 172 | + if ($child['mimetype'] === 'httpd/unix-directory') { |
|
| 173 | + $this->rmObjects($child['path']); |
|
| 174 | + } else { |
|
| 175 | + $this->unlink($child['path']); |
|
| 176 | + } |
|
| 177 | + } |
|
| 178 | + } |
|
| 179 | + |
|
| 180 | + public function unlink($path) { |
|
| 181 | + $path = $this->normalizePath($path); |
|
| 182 | + $stat = $this->stat($path); |
|
| 183 | + |
|
| 184 | + if ($stat && isset($stat['fileid'])) { |
|
| 185 | + if ($stat['mimetype'] === 'httpd/unix-directory') { |
|
| 186 | + return $this->rmdir($path); |
|
| 187 | + } |
|
| 188 | + try { |
|
| 189 | + $this->objectStore->deleteObject($this->getURN($stat['fileid'])); |
|
| 190 | + } catch (\Exception $ex) { |
|
| 191 | + if ($ex->getCode() !== 404) { |
|
| 192 | + $this->logger->logException($ex, [ |
|
| 193 | + 'app' => 'objectstore', |
|
| 194 | + 'message' => 'Could not delete object ' . $this->getURN($stat['fileid']) . ' for ' . $path, |
|
| 195 | + ]); |
|
| 196 | + return false; |
|
| 197 | + } else { |
|
| 198 | + //removing from cache is ok as it does not exist in the objectstore anyway |
|
| 199 | + } |
|
| 200 | + } |
|
| 201 | + $this->getCache()->remove($path); |
|
| 202 | + return true; |
|
| 203 | + } |
|
| 204 | + return false; |
|
| 205 | + } |
|
| 206 | + |
|
| 207 | + public function stat($path) { |
|
| 208 | + $path = $this->normalizePath($path); |
|
| 209 | + $cacheEntry = $this->getCache()->get($path); |
|
| 210 | + if ($cacheEntry instanceof CacheEntry) { |
|
| 211 | + return $cacheEntry->getData(); |
|
| 212 | + } else { |
|
| 213 | + return false; |
|
| 214 | + } |
|
| 215 | + } |
|
| 216 | + |
|
| 217 | + /** |
|
| 218 | + * Override this method if you need a different unique resource identifier for your object storage implementation. |
|
| 219 | + * The default implementations just appends the fileId to 'urn:oid:'. Make sure the URN is unique over all users. |
|
| 220 | + * You may need a mapping table to store your URN if it cannot be generated from the fileid. |
|
| 221 | + * |
|
| 222 | + * @param int $fileId the fileid |
|
| 223 | + * @return null|string the unified resource name used to identify the object |
|
| 224 | + */ |
|
| 225 | + protected function getURN($fileId) { |
|
| 226 | + if (is_numeric($fileId)) { |
|
| 227 | + return $this->objectPrefix . $fileId; |
|
| 228 | + } |
|
| 229 | + return null; |
|
| 230 | + } |
|
| 231 | + |
|
| 232 | + public function opendir($path) { |
|
| 233 | + $path = $this->normalizePath($path); |
|
| 234 | + |
|
| 235 | + try { |
|
| 236 | + $files = array(); |
|
| 237 | + $folderContents = $this->getCache()->getFolderContents($path); |
|
| 238 | + foreach ($folderContents as $file) { |
|
| 239 | + $files[] = $file['name']; |
|
| 240 | + } |
|
| 241 | + |
|
| 242 | + return IteratorDirectory::wrap($files); |
|
| 243 | + } catch (\Exception $e) { |
|
| 244 | + $this->logger->logException($e); |
|
| 245 | + return false; |
|
| 246 | + } |
|
| 247 | + } |
|
| 248 | + |
|
| 249 | + public function filetype($path) { |
|
| 250 | + $path = $this->normalizePath($path); |
|
| 251 | + $stat = $this->stat($path); |
|
| 252 | + if ($stat) { |
|
| 253 | + if ($stat['mimetype'] === 'httpd/unix-directory') { |
|
| 254 | + return 'dir'; |
|
| 255 | + } |
|
| 256 | + return 'file'; |
|
| 257 | + } else { |
|
| 258 | + return false; |
|
| 259 | + } |
|
| 260 | + } |
|
| 261 | + |
|
| 262 | + public function fopen($path, $mode) { |
|
| 263 | + $path = $this->normalizePath($path); |
|
| 264 | + |
|
| 265 | + switch ($mode) { |
|
| 266 | + case 'r': |
|
| 267 | + case 'rb': |
|
| 268 | + $stat = $this->stat($path); |
|
| 269 | + if (is_array($stat)) { |
|
| 270 | + try { |
|
| 271 | + return $this->objectStore->readObject($this->getURN($stat['fileid'])); |
|
| 272 | + } catch (\Exception $ex) { |
|
| 273 | + $this->logger->logException($ex, [ |
|
| 274 | + 'app' => 'objectstore', |
|
| 275 | + 'message' => 'Count not get object ' . $this->getURN($stat['fileid']) . ' for file ' . $path, |
|
| 276 | + ]); |
|
| 277 | + return false; |
|
| 278 | + } |
|
| 279 | + } else { |
|
| 280 | + return false; |
|
| 281 | + } |
|
| 282 | + case 'w': |
|
| 283 | + case 'wb': |
|
| 284 | + case 'a': |
|
| 285 | + case 'ab': |
|
| 286 | + case 'r+': |
|
| 287 | + case 'w+': |
|
| 288 | + case 'wb+': |
|
| 289 | + case 'a+': |
|
| 290 | + case 'x': |
|
| 291 | + case 'x+': |
|
| 292 | + case 'c': |
|
| 293 | + case 'c+': |
|
| 294 | + if (strrpos($path, '.') !== false) { |
|
| 295 | + $ext = substr($path, strrpos($path, '.')); |
|
| 296 | + } else { |
|
| 297 | + $ext = ''; |
|
| 298 | + } |
|
| 299 | + $tmpFile = \OC::$server->getTempManager()->getTemporaryFile($ext); |
|
| 300 | + if ($this->file_exists($path)) { |
|
| 301 | + $source = $this->fopen($path, 'r'); |
|
| 302 | + file_put_contents($tmpFile, $source); |
|
| 303 | + } |
|
| 304 | + $handle = fopen($tmpFile, $mode); |
|
| 305 | + return CallbackWrapper::wrap($handle, null, null, function () use ($path, $tmpFile) { |
|
| 306 | + $this->writeBack($tmpFile, $path); |
|
| 307 | + }); |
|
| 308 | + } |
|
| 309 | + return false; |
|
| 310 | + } |
|
| 311 | + |
|
| 312 | + public function file_exists($path) { |
|
| 313 | + $path = $this->normalizePath($path); |
|
| 314 | + return (bool)$this->stat($path); |
|
| 315 | + } |
|
| 316 | + |
|
| 317 | + public function rename($source, $target) { |
|
| 318 | + $source = $this->normalizePath($source); |
|
| 319 | + $target = $this->normalizePath($target); |
|
| 320 | + $this->remove($target); |
|
| 321 | + $this->getCache()->move($source, $target); |
|
| 322 | + $this->touch(dirname($target)); |
|
| 323 | + return true; |
|
| 324 | + } |
|
| 325 | + |
|
| 326 | + public function getMimeType($path) { |
|
| 327 | + $path = $this->normalizePath($path); |
|
| 328 | + $stat = $this->stat($path); |
|
| 329 | + if (is_array($stat)) { |
|
| 330 | + return $stat['mimetype']; |
|
| 331 | + } else { |
|
| 332 | + return false; |
|
| 333 | + } |
|
| 334 | + } |
|
| 335 | + |
|
| 336 | + public function touch($path, $mtime = null) { |
|
| 337 | + if (is_null($mtime)) { |
|
| 338 | + $mtime = time(); |
|
| 339 | + } |
|
| 340 | + |
|
| 341 | + $path = $this->normalizePath($path); |
|
| 342 | + $dirName = dirname($path); |
|
| 343 | + $parentExists = $this->is_dir($dirName); |
|
| 344 | + if (!$parentExists) { |
|
| 345 | + return false; |
|
| 346 | + } |
|
| 347 | + |
|
| 348 | + $stat = $this->stat($path); |
|
| 349 | + if (is_array($stat)) { |
|
| 350 | + // update existing mtime in db |
|
| 351 | + $stat['mtime'] = $mtime; |
|
| 352 | + $this->getCache()->update($stat['fileid'], $stat); |
|
| 353 | + } else { |
|
| 354 | + $mimeType = \OC::$server->getMimeTypeDetector()->detectPath($path); |
|
| 355 | + // create new file |
|
| 356 | + $stat = array( |
|
| 357 | + 'etag' => $this->getETag($path), |
|
| 358 | + 'mimetype' => $mimeType, |
|
| 359 | + 'size' => 0, |
|
| 360 | + 'mtime' => $mtime, |
|
| 361 | + 'storage_mtime' => $mtime, |
|
| 362 | + 'permissions' => \OCP\Constants::PERMISSION_ALL - \OCP\Constants::PERMISSION_CREATE, |
|
| 363 | + ); |
|
| 364 | + $fileId = $this->getCache()->put($path, $stat); |
|
| 365 | + try { |
|
| 366 | + //read an empty file from memory |
|
| 367 | + $this->objectStore->writeObject($this->getURN($fileId), fopen('php://memory', 'r')); |
|
| 368 | + } catch (\Exception $ex) { |
|
| 369 | + $this->getCache()->remove($path); |
|
| 370 | + $this->logger->logException($ex, [ |
|
| 371 | + 'app' => 'objectstore', |
|
| 372 | + 'message' => 'Could not create object ' . $this->getURN($fileId) . ' for ' . $path, |
|
| 373 | + ]); |
|
| 374 | + return false; |
|
| 375 | + } |
|
| 376 | + } |
|
| 377 | + return true; |
|
| 378 | + } |
|
| 379 | + |
|
| 380 | + public function writeBack($tmpFile, $path) { |
|
| 381 | + $stat = $this->stat($path); |
|
| 382 | + if (empty($stat)) { |
|
| 383 | + // create new file |
|
| 384 | + $stat = array( |
|
| 385 | + 'permissions' => \OCP\Constants::PERMISSION_ALL - \OCP\Constants::PERMISSION_CREATE, |
|
| 386 | + ); |
|
| 387 | + } |
|
| 388 | + // update stat with new data |
|
| 389 | + $mTime = time(); |
|
| 390 | + $stat['size'] = filesize($tmpFile); |
|
| 391 | + $stat['mtime'] = $mTime; |
|
| 392 | + $stat['storage_mtime'] = $mTime; |
|
| 393 | + $stat['mimetype'] = \OC::$server->getMimeTypeDetector()->detect($tmpFile); |
|
| 394 | + $stat['etag'] = $this->getETag($path); |
|
| 395 | + |
|
| 396 | + $fileId = $this->getCache()->put($path, $stat); |
|
| 397 | + try { |
|
| 398 | + //upload to object storage |
|
| 399 | + $this->objectStore->writeObject($this->getURN($fileId), fopen($tmpFile, 'r')); |
|
| 400 | + } catch (\Exception $ex) { |
|
| 401 | + $this->getCache()->remove($path); |
|
| 402 | + $this->logger->logException($ex, [ |
|
| 403 | + 'app' => 'objectstore', |
|
| 404 | + 'message' => 'Could not create object ' . $this->getURN($fileId) . ' for ' . $path, |
|
| 405 | + ]); |
|
| 406 | + throw $ex; // make this bubble up |
|
| 407 | + } |
|
| 408 | + } |
|
| 409 | + |
|
| 410 | + /** |
|
| 411 | + * external changes are not supported, exclusive access to the object storage is assumed |
|
| 412 | + * |
|
| 413 | + * @param string $path |
|
| 414 | + * @param int $time |
|
| 415 | + * @return false |
|
| 416 | + */ |
|
| 417 | + public function hasUpdated($path, $time) { |
|
| 418 | + return false; |
|
| 419 | + } |
|
| 420 | 420 | } |
@@ -55,9 +55,9 @@ discard block |
||
| 55 | 55 | throw new \Exception('missing IObjectStore instance'); |
| 56 | 56 | } |
| 57 | 57 | if (isset($params['storageid'])) { |
| 58 | - $this->id = 'object::store:' . $params['storageid']; |
|
| 58 | + $this->id = 'object::store:'.$params['storageid']; |
|
| 59 | 59 | } else { |
| 60 | - $this->id = 'object::store:' . $this->objectStore->getStorageId(); |
|
| 60 | + $this->id = 'object::store:'.$this->objectStore->getStorageId(); |
|
| 61 | 61 | } |
| 62 | 62 | if (isset($params['objectPrefix'])) { |
| 63 | 63 | $this->objectPrefix = $params['objectPrefix']; |
@@ -191,7 +191,7 @@ discard block |
||
| 191 | 191 | if ($ex->getCode() !== 404) { |
| 192 | 192 | $this->logger->logException($ex, [ |
| 193 | 193 | 'app' => 'objectstore', |
| 194 | - 'message' => 'Could not delete object ' . $this->getURN($stat['fileid']) . ' for ' . $path, |
|
| 194 | + 'message' => 'Could not delete object '.$this->getURN($stat['fileid']).' for '.$path, |
|
| 195 | 195 | ]); |
| 196 | 196 | return false; |
| 197 | 197 | } else { |
@@ -224,7 +224,7 @@ discard block |
||
| 224 | 224 | */ |
| 225 | 225 | protected function getURN($fileId) { |
| 226 | 226 | if (is_numeric($fileId)) { |
| 227 | - return $this->objectPrefix . $fileId; |
|
| 227 | + return $this->objectPrefix.$fileId; |
|
| 228 | 228 | } |
| 229 | 229 | return null; |
| 230 | 230 | } |
@@ -272,7 +272,7 @@ discard block |
||
| 272 | 272 | } catch (\Exception $ex) { |
| 273 | 273 | $this->logger->logException($ex, [ |
| 274 | 274 | 'app' => 'objectstore', |
| 275 | - 'message' => 'Count not get object ' . $this->getURN($stat['fileid']) . ' for file ' . $path, |
|
| 275 | + 'message' => 'Count not get object '.$this->getURN($stat['fileid']).' for file '.$path, |
|
| 276 | 276 | ]); |
| 277 | 277 | return false; |
| 278 | 278 | } |
@@ -302,7 +302,7 @@ discard block |
||
| 302 | 302 | file_put_contents($tmpFile, $source); |
| 303 | 303 | } |
| 304 | 304 | $handle = fopen($tmpFile, $mode); |
| 305 | - return CallbackWrapper::wrap($handle, null, null, function () use ($path, $tmpFile) { |
|
| 305 | + return CallbackWrapper::wrap($handle, null, null, function() use ($path, $tmpFile) { |
|
| 306 | 306 | $this->writeBack($tmpFile, $path); |
| 307 | 307 | }); |
| 308 | 308 | } |
@@ -311,7 +311,7 @@ discard block |
||
| 311 | 311 | |
| 312 | 312 | public function file_exists($path) { |
| 313 | 313 | $path = $this->normalizePath($path); |
| 314 | - return (bool)$this->stat($path); |
|
| 314 | + return (bool) $this->stat($path); |
|
| 315 | 315 | } |
| 316 | 316 | |
| 317 | 317 | public function rename($source, $target) { |
@@ -369,7 +369,7 @@ discard block |
||
| 369 | 369 | $this->getCache()->remove($path); |
| 370 | 370 | $this->logger->logException($ex, [ |
| 371 | 371 | 'app' => 'objectstore', |
| 372 | - 'message' => 'Could not create object ' . $this->getURN($fileId) . ' for ' . $path, |
|
| 372 | + 'message' => 'Could not create object '.$this->getURN($fileId).' for '.$path, |
|
| 373 | 373 | ]); |
| 374 | 374 | return false; |
| 375 | 375 | } |
@@ -401,7 +401,7 @@ discard block |
||
| 401 | 401 | $this->getCache()->remove($path); |
| 402 | 402 | $this->logger->logException($ex, [ |
| 403 | 403 | 'app' => 'objectstore', |
| 404 | - 'message' => 'Could not create object ' . $this->getURN($fileId) . ' for ' . $path, |
|
| 404 | + 'message' => 'Could not create object '.$this->getURN($fileId).' for '.$path, |
|
| 405 | 405 | ]); |
| 406 | 406 | throw $ex; // make this bubble up |
| 407 | 407 | } |
