apps/files_sharing/js/app.js
/*
* Copyright (c) 2014 Vincent Petry <pvince81@owncloud.com>
*
* This file is licensed under the Affero General Public License version 3
* or later.
*
* See the COPYING-README file.
*
*/
if (!OCA.Sharing) {
/**
* @namespace OCA.Sharing
*/
OCA.Sharing = {};
}
/**
* @namespace
*/
OCA.Sharing.App = {
_inFileList: null,
_outFileList: null,
initSharingIn: function($el) {
if (this._inFileList) {
return this._inFileList;
}
var fileActions = this._createFileActions();
var urlParams = OC.Util.History.parseUrlQuery();
this._inFileList = new OCA.Sharing.FileList(
$el,
{
id: 'shares.self',
scrollContainer: $('#app-content'),
scrollTo: urlParams.scrollto,
sharedWithUser: true,
fileActions: fileActions,
config: OCA.Files.App.getFilesConfig()
}
);
this._registerPendingShareActions(fileActions);
this._extendFileList(this._inFileList);
this._inFileList.appName = t('files_sharing', 'Shared with you');
this._inFileList.$el.find('#emptycontent').html('<div class="icon-shared"></div>' +
'<h2>' + t('files_sharing', 'Nothing shared with you yet') + '</h2>' +
'<p>' + t('files_sharing', 'Files and folders others share with you will show up here') + '</p>');
return this._inFileList;
},
initSharingOut: function($el) {
if (this._outFileList) {
return this._outFileList;
}
var fileActions = this._createFileActions();
this._adjustOutAndLinkShareActions(fileActions);
this._outFileList = new OCA.Sharing.FileList(
$el,
{
id: 'shares.others',
scrollContainer: $('#app-content'),
sharedWithUser: false,
fileActions: fileActions,
config: OCA.Files.App.getFilesConfig()
}
);
this._extendFileList(this._outFileList);
this._outFileList.appName = t('files_sharing', 'Shared with others');
this._outFileList.$el.find('#emptycontent').html('<div class="icon-shared"></div>' +
'<h2>' + t('files_sharing', 'Nothing shared yet') + '</h2>' +
'<p>' + t('files_sharing', 'Files and folders you share will show up here') + '</p>');
return this._outFileList;
},
initSharingLinks: function($el) {
if (this._linkFileList) {
return this._linkFileList;
}
var fileActions = this._createFileActions();
this._adjustOutAndLinkShareActions(fileActions);
this._linkFileList = new OCA.Sharing.FileList(
$el,
{
id: 'shares.link',
scrollContainer: $('#app-content'),
linksOnly: true,
fileActions: fileActions,
config: OCA.Files.App.getFilesConfig()
}
);
this._extendFileList(this._linkFileList);
this._linkFileList.appName = t('files_sharing', 'Shared by link');
this._linkFileList.$el.find('#emptycontent').html('<div class="icon-public"></div>' +
'<h2>' + t('files_sharing', 'No shared links') + '</h2>' +
'<p>' + t('files_sharing', 'Files and folders you share by link will show up here') + '</p>');
return this._linkFileList;
},
removeSharingIn: function() {
if (this._inFileList) {
this._inFileList.destroy();
this._inFileList = null;
}
},
removeSharingOut: function() {
if (this._outFileList) {
this._outFileList.destroy();
this._outFileList = null;
}
},
removeSharingLinks: function() {
if (this._linkFileList) {
this._linkFileList.destroy();
this._linkFileList = null;
}
},
registerNotificationHandler: function() {
this._onNotificationEvent = _.bind(this._onNotificationEvent, this);
$('body').on('OCA.Notification.Action', this._onNotificationEvent);
},
/**
* Destroy the app
*/
destroy: function() {
$('body').off('OCA.Notification.Action', this._onNotificationEvent);
OCA.Files.fileActions.off('setDefault.app-sharing', this._onActionsUpdated);
OCA.Files.fileActions.off('registerAction.app-sharing', this._onActionsUpdated);
this.removeSharingIn();
this.removeSharingOut();
this.removeSharingLinks();
this._inFileList = null;
this._outFileList = null;
this._linkFileList = null;
delete this._globalActionsInitialized;
},
_onNotificationEvent: function(e) {
if (e.notification.app === 'files_sharing') {
if (this._inFileList) {
this._inFileList.reload();
}
if (e.action.type === 'POST' && OCA.Files && OCA.Files.App && OCA.Files.App.fileList) {
// reload the file list only if the share is accepted
// both internal sharing and remote sharing
OCA.Files.App.fileList.reload();
}
}
},
_createFileActions: function() {
// inherit file actions from the files app
var fileActions = new OCA.Files.FileActions();
// note: not merging the legacy actions because legacy apps are not
// compatible with the sharing overview and need to be adapted first
fileActions.registerDefaultActions();
fileActions.merge(OCA.Files.fileActions);
if (!this._globalActionsInitialized) {
// in case actions are registered later
this._onActionsUpdated = _.bind(this._onActionsUpdated, this);
OCA.Files.fileActions.on('setDefault.app-sharing', this._onActionsUpdated);
OCA.Files.fileActions.on('registerAction.app-sharing', this._onActionsUpdated);
this._globalActionsInitialized = true;
}
// when the user clicks on a folder, redirect to the corresponding
// folder in the files app instead of opening it directly
fileActions.register('dir', 'Open', OC.PERMISSION_READ, '', function (filename, context) {
OCA.Files.App.setActiveView('files', {silent: true});
OCA.Files.App.fileList.changeDirectory(OC.joinPaths(context.$file.attr('data-path'), filename), true, true);
});
fileActions.setDefault('dir', 'Open');
return fileActions;
},
_onActionsUpdated: function(ev) {
_.each([this._inFileList, this._outFileList, this._linkFileList], function(list) {
if (!list) {
return;
}
if (ev.action) {
list.fileActions.registerAction(ev.action);
} else if (ev.defaultAction) {
list.fileActions.setDefault(
ev.defaultAction.mime,
ev.defaultAction.name
);
}
});
},
_extendFileList: function(fileList) {
// remove size column from summary
fileList.fileSummary.$el.find('.filesize').remove();
},
_setShareState: function(fileId, state, isRemote, shareType) {
var method = 'POST';
if (state === OC.Share.STATE_REJECTED) {
method = 'DELETE';
}
var endPoint = isRemote === true ? 'remote_shares/pending/' : 'shares/pending/';
var xhr = $.ajax({
url: OC.linkToOCS('apps/files_sharing/api/v1') + endPoint + encodeURIComponent(fileId) + '?format=json',
contentType: 'application/json',
dataType: 'json',
type: method,
// be aware that `shareType` should not be an empty string
data: JSON.stringify((shareType !== undefined ? { shareType: shareType } : {})),
});
xhr.fail(function(response) {
var message = '';
// show message if it is available
if(response.responseJSON && response.responseJSON.message) {
message = ': ' + response.responseJSON.message;
}
OC.Notification.show(t('files_sharing', 'An error occurred while updating share state: {message}', {message: message}), {type: 'error'});
});
return xhr;
},
_shareStateActionHandler: function(context, newState) {
var targetFileData = context.fileList.elementToFile(context.$file);
var isRemote = targetFileData.shareLocationType === 'remote';
const shareType = targetFileData.shareType;
function responseCallback(response, status) {
if (status === 'success') {
var meta = response.ocs.meta;
if (meta.status === 'ok') {
context.fileList.reload();
} else {
OC.Notification.show(
t('files_sharing', 'An error occurred while updating share state: {message}',
{message: meta.message}, 0, {escape: false}), {type: 'error'}
);
context.fileList.showFileBusyState(context.$file, false);
}
}
}
context.fileList.showFileBusyState(context.$file, true);
this._setShareState(context.fileInfoModel.get('shares')[0].id, newState, isRemote, shareType)
.then(responseCallback);
},
_registerPendingShareActions: function(fileActions) {
var self = this;
// register pending share actions
fileActions.registerAction({
name: 'Accept',
type: OCA.Files.FileActions.TYPE_INLINE,
displayName: t('files_sharing', 'Accept Share'),
mime: 'all',
iconClass: 'icon-checkmark',
permissions: OC.PERMISSION_READ,
actionHandler: function (filename, context) {
self._shareStateActionHandler(context, OC.Share.STATE_ACCEPTED);
}
});
fileActions.registerAction({
name: 'Reject',
type: OCA.Files.FileActions.TYPE_INLINE,
displayName: t('files_sharing', 'Decline Share'),
iconClass: 'icon-close',
mime: 'all',
permissions: OC.PERMISSION_READ,
actionHandler: function (filename, context) {
self._shareStateActionHandler(context, OC.Share.STATE_REJECTED);
}
});
fileActions.addAdvancedFilter(function(actions, context) {
var shareState = parseInt(context.$file.attr('data-share-state'), 10);
if (isNaN(shareState)) {
// called out of context ?
return actions;
}
var targetFileData = context.fileList.elementToFile(context.$file);
if (targetFileData.shareLocationType === 'remote') {
// accept and reject will be removed for remote shares
if (shareState === OC.Share.STATE_PENDING) {
delete(actions.Download);
delete(actions.Details);
delete(actions.Delete);
delete(actions.Unshare);
} else {
delete(actions.Accept);
delete(actions.Reject);
}
return actions;
}
if (shareState === OC.Share.STATE_ACCEPTED) {
delete(actions.Accept);
// move "Reject" into drop down to replace "Delete" action
actions.Reject.type = OCA.Files.FileActions.TYPE_DROPDOWN;
delete(actions.Delete);
return actions;
}
var newActions = [];
if (actions.Share) {
newActions.push(actions.Share);
}
if (actions.Accept && actions.Reject) {
if (shareState === OC.Share.STATE_PENDING || shareState === OC.Share.STATE_REJECTED) {
newActions.push(actions.Accept);
}
if (shareState === OC.Share.STATE_PENDING) {
actions.Reject.type = OCA.Files.FileActions.TYPE_INLINE;
newActions.push(actions.Reject);
}
}
return newActions;
});
},
_adjustOutAndLinkShareActions: function(fileActions) {
fileActions.addAdvancedFilter(function(actions, context) {
// delete action is removed to prevent confusion. Users might accidentally
// delete a file or a folder instead of unsharing it.
// If the user clicks in the folder, he'll be moved to the "all files" section,
// so there is no need check for additional context and we'll remove the delete
// action from all the files and folders in the list.
delete(actions.Delete);
return actions;
});
}
};
$(document).ready(function() {
$('#app-content-sharingin').on('show', function(e) {
OCA.Sharing.App.initSharingIn($(e.target));
});
$('#app-content-sharingin').on('hide', function() {
OCA.Sharing.App.removeSharingIn();
});
$('#app-content-sharingout').on('show', function(e) {
OCA.Sharing.App.initSharingOut($(e.target));
});
$('#app-content-sharingout').on('hide', function() {
OCA.Sharing.App.removeSharingOut();
});
$('#app-content-sharinglinks').on('show', function(e) {
OCA.Sharing.App.initSharingLinks($(e.target));
});
$('#app-content-sharinglinks').on('hide', function() {
OCA.Sharing.App.removeSharingLinks();
});
OCA.Sharing.App.registerNotificationHandler();
});