Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow to directly set the expireDate on a new (link)share #18651

Merged
merged 2 commits into from
Aug 30, 2015
Merged

Allow to directly set the expireDate on a new (link)share #18651

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fc64ea6
Allow to directly set the expireDate on a new (link)share
rullzer Aug 29, 2015
2aff11c
Actually validate the expire date on share
rullzer Aug 29, 2015
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 41 additions & 3 deletions apps/files_sharing/api/local.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -258,6 +258,7 @@ public static function createShare($params) {
$itemSource = self::getFileId($path);
$itemSourceName = $itemSource;
$itemType = self::getItemType($path);
$expirationDate = null;

if($itemSource === null) {
return new \OC_OCS_Result(null, 404, "wrong path, file/folder doesn't exist.");
Expand Down Expand Up @@ -286,6 +287,14 @@ public static function createShare($params) {
// read, create, update (7) if public upload is enabled or
// read (1) if public upload is disabled
$permissions = $publicUpload === 'true' ? 7 : 1;

// Get the expiration date
try {
$expirationDate = isset($_POST['expireDate']) ? self::parseDate($_POST['expireDate']) : null;
} catch (\Exception $e) {
return new \OC_OCS_Result(null, 404, 'Invalid Date. Format must be YYYY-MM-DD.');
}

break;
default:
return new \OC_OCS_Result(null, 400, "unknown share type");
Expand All @@ -302,10 +311,15 @@ public static function createShare($params) {
$shareType,
$shareWith,
$permissions,
$itemSourceName
);
$itemSourceName,
$expirationDate
);
} catch (HintException $e) {
return new \OC_OCS_Result(null, 400, $e->getHint());
if ($e->getCode() === 0) {
return new \OC_OCS_Result(null, 400, $e->getHint());
} else {
return new \OC_OCS_Result(null, $e->getCode(), $e->getHint());
}
} catch (\Exception $e) {
return new \OC_OCS_Result(null, 403, $e->getMessage());
}
Expand Down Expand Up @@ -537,6 +551,30 @@ public static function deleteShare($params) {
}
}

/**
* Make sure that the passed date is valid ISO 8601
* So YYYY-MM-DD
* If not throw an exception
*
* @param string $expireDate
*
* @throws \Exception
* @return \DateTime
*/
private static function parseDate($expireDate) {
if (preg_match('/^\d{4}-\d{2}-\d{2}$/', $expireDate) === 0) {
throw new \Exception('Invalid date. Format must be YYYY-MM-DD');
}

$date = new \DateTime($expireDate);

if ($date === false) {
throw new \Exception('Invalid date. Format must be YYYY-MM-DD');
}

return $date;
}

/**
* get file ID from a given path
* @param string $path
Expand Down
142 changes: 142 additions & 0 deletions apps/files_sharing/tests/api.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1487,4 +1487,146 @@ public function testDefaultExpireDate() {
$config->setAppValue('core', 'shareapi_enforce_expire_date', 'no');

}

public function datesProvider() {
$date = new \DateTime();
$date->add(new \DateInterval('P5D'));

$year = (int)$date->format('Y');

return [
[$date->format('Y-m-d'), true],
[$year+1 . '-1-1', false],
[$date->format('Y-m-dTH:m'), false],
['abc', false],
[$date->format('Y-m-d') . 'xyz', false],
];
}

/**
* Make sure only ISO 8601 dates are accepted
*
* @dataProvider datesProvider
*/
public function testPublicLinkExpireDate($date, $valid) {
$_POST['path'] = $this->folder;
$_POST['shareType'] = \OCP\Share::SHARE_TYPE_LINK;
$_POST['expireDate'] = $date;

$result = \OCA\Files_Sharing\API\Local::createShare([]);

if ($valid === false) {
$this->assertFalse($result->succeeded());
$this->assertEquals(404, $result->getStatusCode());
$this->assertEquals('Invalid Date. Format must be YYYY-MM-DD.', $result->getMeta()['message']);
return;
}

$this->assertTrue($result->succeeded());

$data = $result->getData();
$this->assertTrue(is_string($data['token']));

// check for correct link
$url = \OC::$server->getURLGenerator()->getAbsoluteURL('/index.php/s/' . $data['token']);
$this->assertEquals($url, $data['url']);


$share = $this->getShareFromId($data['id']);
$items = \OCP\Share::getItemShared('file', $share['item_source']);
$this->assertTrue(!empty($items));

$item = reset($items);
$this->assertTrue(is_array($item));
$this->assertEquals($date, substr($item['expiration'], 0, 10));

$fileinfo = $this->view->getFileInfo($this->folder);
\OCP\Share::unshare('folder', $fileinfo['fileid'], \OCP\Share::SHARE_TYPE_LINK, null);
}

public function testCreatePublicLinkExpireDateValid() {
$config = \OC::$server->getConfig();

// enforce expire date, by default 7 days after the file was shared
$config->setAppValue('core', 'shareapi_default_expire_date', 'yes');
$config->setAppValue('core', 'shareapi_enforce_expire_date', 'yes');

$date = new \DateTime();
$date->add(new \DateInterval('P5D'));

$_POST['path'] = $this->folder;
$_POST['shareType'] = \OCP\Share::SHARE_TYPE_LINK;
$_POST['expireDate'] = $date->format('Y-m-d');

$result = \OCA\Files_Sharing\API\Local::createShare([]);

$this->assertTrue($result->succeeded());

$data = $result->getData();
$this->assertTrue(is_string($data['token']));

// check for correct link
$url = \OC::$server->getURLGenerator()->getAbsoluteURL('/index.php/s/' . $data['token']);
$this->assertEquals($url, $data['url']);


$share = $this->getShareFromId($data['id']);
$items = \OCP\Share::getItemShared('file', $share['item_source']);
$this->assertTrue(!empty($items));

$item = reset($items);
$this->assertTrue(is_array($item));
$this->assertEquals($date->format('Y-m-d'), substr($item['expiration'], 0, 10));

$fileinfo = $this->view->getFileInfo($this->folder);
\OCP\Share::unshare('folder', $fileinfo['fileid'], \OCP\Share::SHARE_TYPE_LINK, null);

$config->setAppValue('core', 'shareapi_default_expire_date', 'no');
$config->setAppValue('core', 'shareapi_enforce_expire_date', 'no');
}

public function testCreatePublicLinkExpireDateInvalidFuture() {
$config = \OC::$server->getConfig();

// enforce expire date, by default 7 days after the file was shared
$config->setAppValue('core', 'shareapi_default_expire_date', 'yes');
$config->setAppValue('core', 'shareapi_enforce_expire_date', 'yes');

$date = new \DateTime();
$date->add(new \DateInterval('P8D'));

$_POST['path'] = $this->folder;
$_POST['shareType'] = \OCP\Share::SHARE_TYPE_LINK;
$_POST['expireDate'] = $date->format('Y-m-d');

$result = \OCA\Files_Sharing\API\Local::createShare([]);

$this->assertFalse($result->succeeded());
$this->assertEquals(404, $result->getStatusCode());
$this->assertEquals('Cannot set expiration date. Shares cannot expire later than 7 after they have been shared', $result->getMeta()['message']);

$config->setAppValue('core', 'shareapi_default_expire_date', 'no');
$config->setAppValue('core', 'shareapi_enforce_expire_date', 'no');
}

public function testCreatePublicLinkExpireDateInvalidPast() {
$config = \OC::$server->getConfig();

$date = new \DateTime();
$date->sub(new \DateInterval('P8D'));

$_POST['path'] = $this->folder;
$_POST['shareType'] = \OCP\Share::SHARE_TYPE_LINK;
$_POST['expireDate'] = $date->format('Y-m-d');

$result = \OCA\Files_Sharing\API\Local::createShare([]);

$this->assertFalse($result->succeeded());
$this->assertEquals(404, $result->getStatusCode());
$this->assertEquals('Cannot set expiration date. Expiration date is in the past', $result->getMeta()['message']);

$config->setAppValue('core', 'shareapi_default_expire_date', 'no');
$config->setAppValue('core', 'shareapi_enforce_expire_date', 'no');
}

}
15 changes: 15 additions & 0 deletions lib/private/share/share.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -649,6 +649,21 @@ public static function shareItem($itemType, $itemSource, $shareType, $shareWith,
$permissions = (int)$permissions & ~\OCP\Constants::PERMISSION_DELETE;
}

//Validate expirationDate
if ($expirationDate !== null) {
try {
/*
* Reuse the validateExpireDate.
* We have to pass time() since the second arg is the time
* the file was shared, since it is not shared yet we just use
* the current time.
*/
$expirationDate = self::validateExpireDate($expirationDate->format('Y-m-d'), time(), $itemType, $itemSource);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can you add a comment to explain why we're passing time() here ?

} catch (\Exception $e) {
throw new \OC\HintException($e->getMessage(), $e->getMessage(), 404);
}
}

// Verify share type and sharing conditions are met
if ($shareType === self::SHARE_TYPE_USER) {
if ($shareWith == $uidOwner) {
Expand Down