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.

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

Add "Crop image previews" setting to files #25055

Merged
merged 1 commit into from
Jan 15, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 5 additions & 0 deletions apps/files/appinfo/routes.php
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,11 @@
'url' => '/api/v1/showhidden',
'verb' => 'POST'
],
[
'name' => 'API#cropImagePreviews',
'url' => '/api/v1/cropimagepreviews',
'verb' => 'POST'
],
[
'name' => 'API#showGridView',
'url' => '/api/v1/showgridview',
Expand Down
32 changes: 31 additions & 1 deletion apps/files/js/app.js
Original file line number Diff line number Diff line change
Expand Up @@ -56,13 +56,18 @@
var showHidden = $('#showHiddenFiles').val() === "1";
this.$showHiddenFiles.prop('checked', showHidden);

// crop image previews
this.$cropImagePreviews = $('input#cropimagepreviewsToggle');
var cropImagePreviews = $('#cropImagePreviews').val() === "1";
this.$cropImagePreviews.prop('checked', cropImagePreviews);

if ($('#fileNotFound').val() === "1") {
OC.Notification.show(t('files', 'File could not be found'), {type: 'error'});
}

this._filesConfig = new OC.Backbone.Model({
showhidden: showHidden
showhidden: showHidden,
cropimagepreviews: cropImagePreviews,
});

var urlParams = OC.Util.History.parseUrlQuery();
Expand Down Expand Up @@ -132,6 +137,7 @@
});

this._debouncedPersistShowHiddenFilesState = _.debounce(this._persistShowHiddenFilesState, 1200);
this._debouncedPersistCropImagePreviewsState = _.debounce(this._persistCropImagePreviewsState, 1200);

if (sessionStorage.getItem('WhatsNewServerCheck') < (Date.now() - 3600*1000)) {
OCP.WhatsNew.query(); // for Nextcloud server
Expand Down Expand Up @@ -231,6 +237,7 @@

$('#app-navigation').on('itemChanged', _.bind(this._onNavigationChanged, this));
this.$showHiddenFiles.on('change', _.bind(this._onShowHiddenFilesChange, this));
this.$cropImagePreviews.on('change', _.bind(this._onCropImagePreviewsChange, this));
},

/**
Expand All @@ -256,6 +263,29 @@
});
},

/**
* Toggle cropping image previews according to the settings checkbox
*
* @returns void
*/
_onCropImagePreviewsChange: function() {
var crop = this.$cropImagePreviews.is(':checked');
this._filesConfig.set('cropimagepreviews', crop);
this._debouncedPersistCropImagePreviewsState();
},

/**
* Persist crop image previews preference on the server
*
* @returns void
*/
_persistCropImagePreviewsState: function() {
var crop = this._filesConfig.get('cropimagepreviews');
$.post(OC.generateUrl('/apps/files/api/v1/cropimagepreviews'), {
crop: crop
});
},

/**
* Event handler for when the current navigation item has changed
*/
Expand Down
13 changes: 12 additions & 1 deletion apps/files/js/filelist.js
Original file line number Diff line number Diff line change
Expand Up @@ -252,7 +252,8 @@
this._filesConfig = OCA.Files.App.getFilesConfig();
} else {
this._filesConfig = new OC.Backbone.Model({
'showhidden': false
'showhidden': false,
'cropimagepreviews': true
});
}

Expand Down Expand Up @@ -291,6 +292,10 @@
}
});

this._filesConfig.on('change:cropimagepreviews', function() {
self.reload();
});

this.$el.toggleClass('hide-hidden-files', !this._filesConfig.get('showhidden'));
}

Expand Down Expand Up @@ -2215,6 +2220,12 @@
urlSpec.y = Math.ceil(urlSpec.y);
urlSpec.forceIcon = 0;

/**
* Images are cropped to a square by default. Append a=1 to the URL
* if the user wants to see images with original aspect ratio.
*/
urlSpec.a = this._filesConfig.get('cropimagepreviews') ? 0 : 1;

if (typeof urlSpec.fileId !== 'undefined') {
delete urlSpec.file;
return OC.generateUrl('/core/preview?') + $.param(urlSpec);
Expand Down
14 changes: 14 additions & 0 deletions apps/files/lib/Controller/ApiController.php
Original file line number Diff line number Diff line change
Expand Up @@ -280,6 +280,20 @@ public function showHiddenFiles($show) {
return new Response();
}

/**
* Toggle default for cropping preview images
*
* @NoAdminRequired
*
* @param bool $crop
* @return Response
* @throws \OCP\PreConditionNotMetException
*/
public function cropImagePreviews($crop) {
$this->config->setUserValue($this->userSession->getUser()->getUID(), 'files', 'crop_image_previews', (int)$crop);
return new Response();
}

/**
* Toggle default for files grid view
*
Expand Down
2 changes: 2 additions & 0 deletions apps/files/lib/Controller/ViewController.php
Original file line number Diff line number Diff line change
Expand Up @@ -296,6 +296,8 @@ public function index($dir = '', $view = '', $fileid = null, $fileNotFound = fal
$params['isIE'] = \OCP\Util::isIE();
$showHidden = (bool) $this->config->getUserValue($this->userSession->getUser()->getUID(), 'files', 'show_hidden', false);
$params['showHiddenFiles'] = $showHidden ? 1 : 0;
$cropImagePreviews = (bool) $this->config->getUserValue($this->userSession->getUser()->getUID(), 'files', 'crop_image_previews', true);
$params['cropImagePreviews'] = $cropImagePreviews ? 1 : 0;
$params['fileNotFound'] = $fileNotFound ? 1 : 0;
$params['appNavigation'] = $nav;
$params['appContents'] = $contentItems;
Expand Down
5 changes: 5 additions & 0 deletions apps/files/templates/appnavigation.php
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,11 @@
checked="checked" type="checkbox">
<label for="showhiddenfilesToggle"><?php p($l->t('Show hidden files')); ?></label>
</div>
<div id="files-setting-cropimagepreviews">
<input class="checkbox" id="cropimagepreviewsToggle"
checked="checked" type="checkbox">
<label for="cropimagepreviewsToggle"><?php p($l->t('Crop image previews')); ?></label>
</div>
<label for="webdavurl"><?php p($l->t('WebDAV')); ?></label>
<input id="webdavurl" type="text" readonly="readonly"
value="<?php p($_['webdav_url']); ?>"/>
Expand Down
1 change: 1 addition & 0 deletions apps/files/templates/index.php
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@
<input type="hidden" name="defaultFileSorting" id="defaultFileSorting" value="<?php p($_['defaultFileSorting']) ?>" />
<input type="hidden" name="defaultFileSortingDirection" id="defaultFileSortingDirection" value="<?php p($_['defaultFileSortingDirection']) ?>" />
<input type="hidden" name="showHiddenFiles" id="showHiddenFiles" value="<?php p($_['showHiddenFiles']); ?>" />
<input type="hidden" name="cropImagePreviews" id="cropImagePreviews" value="<?php p($_['cropImagePreviews']); ?>" />
<?php endif;

foreach ($_['hiddenFields'] as $name => $value) {?>
Expand Down
13 changes: 13 additions & 0 deletions apps/files/tests/Controller/ApiControllerTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -246,4 +246,17 @@ public function testShowHiddenFiles() {

$this->assertEquals($expected, $actual);
}

public function testCropImagePreviews() {
$crop = true;

$this->config->expects($this->once())
->method('setUserValue')
->with($this->user->getUID(), 'files', 'crop_image_previews', $crop);

$expected = new Http\Response();
$actual = $this->apiController->cropImagePreviews($crop);

$this->assertEquals($expected, $actual);
}
}
2 changes: 2 additions & 0 deletions apps/files/tests/Controller/ViewControllerTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,7 @@ public function testIndexWithRegularBrowser() {
[$this->user->getUID(), 'files', 'file_sorting', 'name', 'name'],
[$this->user->getUID(), 'files', 'file_sorting_direction', 'asc', 'asc'],
[$this->user->getUID(), 'files', 'show_hidden', false, false],
[$this->user->getUID(), 'files', 'crop_image_previews', true, true],
[$this->user->getUID(), 'files', 'show_grid', true],
]);

Expand Down Expand Up @@ -316,6 +317,7 @@ public function testIndexWithRegularBrowser() {
'defaultFileSorting' => 'name',
'defaultFileSortingDirection' => 'asc',
'showHiddenFiles' => 0,
'cropImagePreviews' => 1,
'fileNotFound' => 0,
'allowShareWithLink' => 'yes',
'appNavigation' => $nav,
Expand Down