summaryrefslogtreecommitdiffstats
path: root/apps/files_sharing/lib/Helper.php
diff options
context:
space:
mode:
Diffstat (limited to 'apps/files_sharing/lib/Helper.php')
-rw-r--r--apps/files_sharing/lib/Helper.php310
1 files changed, 310 insertions, 0 deletions
diff --git a/apps/files_sharing/lib/Helper.php b/apps/files_sharing/lib/Helper.php
new file mode 100644
index 00000000000..500d82cb2d2
--- /dev/null
+++ b/apps/files_sharing/lib/Helper.php
@@ -0,0 +1,310 @@
+<?php
+/**
+ * @author Bart Visscher <bartv@thisnet.nl>
+ * @author Björn Schießle <schiessle@owncloud.com>
+ * @author Joas Schilling <nickvergessen@owncloud.com>
+ * @author Jörn Friedrich Dreyer <jfd@butonic.de>
+ * @author Lukas Reschke <lukas@owncloud.com>
+ * @author Morris Jobke <hey@morrisjobke.de>
+ * @author Robin Appelman <icewind@owncloud.com>
+ * @author Roeland Jago Douma <rullzer@owncloud.com>
+ * @author Vincent Petry <pvince81@owncloud.com>
+ *
+ * @copyright Copyright (c) 2016, ownCloud, Inc.
+ * @license AGPL-3.0
+ *
+ * This code is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License, version 3,
+ * as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License, version 3,
+ * along with this program. If not, see <http://www.gnu.org/licenses/>
+ *
+ */
+namespace OCA\Files_Sharing;
+
+use OC\Files\Filesystem;
+use OC\Files\View;
+use OCP\Files\NotFoundException;
+use OCP\User;
+
+class Helper {
+
+ public static function registerHooks() {
+ \OCP\Util::connectHook('OC_Filesystem', 'post_rename', '\OCA\Files_Sharing\Updater', 'renameHook');
+ \OCP\Util::connectHook('OC_Filesystem', 'post_delete', '\OCA\Files_Sharing\Hooks', 'unshareChildren');
+ \OCP\Util::connectHook('OC_Appconfig', 'post_set_value', '\OCA\Files_Sharing\Maintainer', 'configChangeHook');
+
+ \OCP\Util::connectHook('OC_User', 'post_deleteUser', '\OCA\Files_Sharing\Hooks', 'deleteUser');
+ }
+
+ /**
+ * Sets up the filesystem and user for public sharing
+ * @param string $token string share token
+ * @param string $relativePath optional path relative to the share
+ * @param string $password optional password
+ * @return array
+ */
+ public static function setupFromToken($token, $relativePath = null, $password = null) {
+ \OC_User::setIncognitoMode(true);
+
+ $linkItem = \OCP\Share::getShareByToken($token, !$password);
+ if($linkItem === false || ($linkItem['item_type'] !== 'file' && $linkItem['item_type'] !== 'folder')) {
+ \OC_Response::setStatus(404);
+ \OCP\Util::writeLog('core-preview', 'Passed token parameter is not valid', \OCP\Util::DEBUG);
+ exit;
+ }
+
+ if(!isset($linkItem['uid_owner']) || !isset($linkItem['file_source'])) {
+ \OC_Response::setStatus(500);
+ \OCP\Util::writeLog('core-preview', 'Passed token seems to be valid, but it does not contain all necessary information . ("' . $token . '")', \OCP\Util::WARN);
+ exit;
+ }
+
+ $rootLinkItem = \OCP\Share::resolveReShare($linkItem);
+ $path = null;
+ if (isset($rootLinkItem['uid_owner'])) {
+ \OCP\JSON::checkUserExists($rootLinkItem['uid_owner']);
+ \OC_Util::tearDownFS();
+ \OC_Util::setupFS($rootLinkItem['uid_owner']);
+ }
+
+ try {
+ $path = Filesystem::getPath($linkItem['file_source']);
+ } catch (NotFoundException $e) {
+ \OCP\Util::writeLog('share', 'could not resolve linkItem', \OCP\Util::DEBUG);
+ \OC_Response::setStatus(404);
+ \OCP\JSON::error(array('success' => false));
+ exit();
+ }
+
+ if (!isset($linkItem['item_type'])) {
+ \OCP\Util::writeLog('share', 'No item type set for share id: ' . $linkItem['id'], \OCP\Util::ERROR);
+ \OC_Response::setStatus(404);
+ \OCP\JSON::error(array('success' => false));
+ exit();
+ }
+
+ if (isset($linkItem['share_with']) && (int)$linkItem['share_type'] === \OCP\Share::SHARE_TYPE_LINK) {
+ if (!self::authenticate($linkItem, $password)) {
+ \OC_Response::setStatus(403);
+ \OCP\JSON::error(array('success' => false));
+ exit();
+ }
+ }
+
+ $basePath = $path;
+
+ if ($relativePath !== null && Filesystem::isReadable($basePath . $relativePath)) {
+ $path .= Filesystem::normalizePath($relativePath);
+ }
+
+ return array(
+ 'linkItem' => $linkItem,
+ 'basePath' => $basePath,
+ 'realPath' => $path
+ );
+ }
+
+ /**
+ * Authenticate link item with the given password
+ * or with the session if no password was given.
+ * @param array $linkItem link item array
+ * @param string $password optional password
+ *
+ * @return boolean true if authorized, false otherwise
+ */
+ public static function authenticate($linkItem, $password = null) {
+ if ($password !== null) {
+ if ($linkItem['share_type'] == \OCP\Share::SHARE_TYPE_LINK) {
+ // Check Password
+ $newHash = '';
+ if(\OC::$server->getHasher()->verify($password, $linkItem['share_with'], $newHash)) {
+ // Save item id in session for future requests
+ \OC::$server->getSession()->set('public_link_authenticated', $linkItem['id']);
+
+ /**
+ * FIXME: Migrate old hashes to new hash format
+ * Due to the fact that there is no reasonable functionality to update the password
+ * of an existing share no migration is yet performed there.
+ * The only possibility is to update the existing share which will result in a new
+ * share ID and is a major hack.
+ *
+ * In the future the migration should be performed once there is a proper method
+ * to update the share's password. (for example `$share->updatePassword($password)`
+ *
+ * @link https://github.com/owncloud/core/issues/10671
+ */
+ if(!empty($newHash)) {
+
+ }
+ } else {
+ return false;
+ }
+ } else {
+ \OCP\Util::writeLog('share', 'Unknown share type '.$linkItem['share_type']
+ .' for share id '.$linkItem['id'], \OCP\Util::ERROR);
+ return false;
+ }
+
+ }
+ else {
+ // not authenticated ?
+ if ( ! \OC::$server->getSession()->exists('public_link_authenticated')
+ || \OC::$server->getSession()->get('public_link_authenticated') !== $linkItem['id']) {
+ return false;
+ }
+ }
+ return true;
+ }
+
+ public static function getSharesFromItem($target) {
+ $result = array();
+ $owner = Filesystem::getOwner($target);
+ Filesystem::initMountPoints($owner);
+ $info = Filesystem::getFileInfo($target);
+ $ownerView = new View('/'.$owner.'/files');
+ if ( $owner != User::getUser() ) {
+ $path = $ownerView->getPath($info['fileid']);
+ } else {
+ $path = $target;
+ }
+
+
+ $ids = array();
+ while ($path !== dirname($path)) {
+ $info = $ownerView->getFileInfo($path);
+ if ($info instanceof \OC\Files\FileInfo) {
+ $ids[] = $info['fileid'];
+ } else {
+ \OCP\Util::writeLog('sharing', 'No fileinfo available for: ' . $path, \OCP\Util::WARN);
+ }
+ $path = dirname($path);
+ }
+
+ if (!empty($ids)) {
+
+ $idList = array_chunk($ids, 99, true);
+
+ foreach ($idList as $subList) {
+ $statement = "SELECT `share_with`, `share_type`, `file_target` FROM `*PREFIX*share` WHERE `file_source` IN (" . implode(',', $subList) . ") AND `share_type` IN (0, 1, 2)";
+ $query = \OCP\DB::prepare($statement);
+ $r = $query->execute();
+ $result = array_merge($result, $r->fetchAll());
+ }
+ }
+
+ return $result;
+ }
+
+ /**
+ * get the UID of the owner of the file and the path to the file relative to
+ * owners files folder
+ *
+ * @param $filename
+ * @return array
+ * @throws \OC\User\NoUserException
+ */
+ public static function getUidAndFilename($filename) {
+ $uid = Filesystem::getOwner($filename);
+ $userManager = \OC::$server->getUserManager();
+ // if the user with the UID doesn't exists, e.g. because the UID points
+ // to a remote user with a federated cloud ID we use the current logged-in
+ // user. We need a valid local user to create the share
+ if (!$userManager->userExists($uid)) {
+ $uid = User::getUser();
+ }
+ Filesystem::initMountPoints($uid);
+ if ( $uid != User::getUser() ) {
+ $info = Filesystem::getFileInfo($filename);
+ $ownerView = new View('/'.$uid.'/files');
+ try {
+ $filename = $ownerView->getPath($info['fileid']);
+ } catch (NotFoundException $e) {
+ $filename = null;
+ }
+ }
+ return [$uid, $filename];
+ }
+
+ /**
+ * Format a path to be relative to the /user/files/ directory
+ * @param string $path the absolute path
+ * @return string e.g. turns '/admin/files/test.txt' into 'test.txt'
+ */
+ public static function stripUserFilesPath($path) {
+ $trimmed = ltrim($path, '/');
+ $split = explode('/', $trimmed);
+
+ // it is not a file relative to data/user/files
+ if (count($split) < 3 || $split[1] !== 'files') {
+ return false;
+ }
+
+ $sliced = array_slice($split, 2);
+ $relPath = implode('/', $sliced);
+
+ return $relPath;
+ }
+
+ /**
+ * check if file name already exists and generate unique target
+ *
+ * @param string $path
+ * @param array $excludeList
+ * @param View $view
+ * @return string $path
+ */
+ public static function generateUniqueTarget($path, $excludeList, $view) {
+ $pathinfo = pathinfo($path);
+ $ext = (isset($pathinfo['extension'])) ? '.'.$pathinfo['extension'] : '';
+ $name = $pathinfo['filename'];
+ $dir = $pathinfo['dirname'];
+ $i = 2;
+ while ($view->file_exists($path) || in_array($path, $excludeList)) {
+ $path = Filesystem::normalizePath($dir . '/' . $name . ' ('.$i.')' . $ext);
+ $i++;
+ }
+
+ return $path;
+ }
+
+ /**
+ * get default share folder
+ *
+ * @return string
+ */
+ public static function getShareFolder() {
+ $shareFolder = \OC::$server->getConfig()->getSystemValue('share_folder', '/');
+ $shareFolder = Filesystem::normalizePath($shareFolder);
+
+ if (!Filesystem::file_exists($shareFolder)) {
+ $dir = '';
+ $subdirs = explode('/', $shareFolder);
+ foreach ($subdirs as $subdir) {
+ $dir = $dir . '/' . $subdir;
+ if (!Filesystem::is_dir($dir)) {
+ Filesystem::mkdir($dir);
+ }
+ }
+ }
+
+ return $shareFolder;
+
+ }
+
+ /**
+ * set default share folder
+ *
+ * @param string $shareFolder
+ */
+ public static function setShareFolder($shareFolder) {
+ \OC::$server->getConfig()->setSystemValue('share_folder', $shareFolder);
+ }
+
+}
generated by cgit v1.2.3 (git 2.39.1) at 2025-01-24 19:59:37 +0000