You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

fileactions.js 25KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867
  1. /*
  2. * Copyright (c) 2014
  3. *
  4. * This file is licensed under the Affero General Public License version 3
  5. * or later.
  6. *
  7. * See the COPYING-README file.
  8. *
  9. */
  10. (function() {
  11. /**
  12. * Construct a new FileActions instance
  13. * @constructs FileActions
  14. * @memberof OCA.Files
  15. */
  16. var FileActions = function() {
  17. this.initialize();
  18. };
  19. FileActions.TYPE_DROPDOWN = 0;
  20. FileActions.TYPE_INLINE = 1;
  21. FileActions.prototype = {
  22. /** @lends FileActions.prototype */
  23. actions: {},
  24. defaults: {},
  25. icons: {},
  26. /**
  27. * @deprecated
  28. */
  29. currentFile: null,
  30. /**
  31. * Dummy jquery element, for events
  32. */
  33. $el: null,
  34. _fileActionTriggerTemplate: null,
  35. /**
  36. * @private
  37. */
  38. initialize: function() {
  39. this.clear();
  40. // abusing jquery for events until we get a real event lib
  41. this.$el = $('<div class="dummy-fileactions hidden"></div>');
  42. $('body').append(this.$el);
  43. this._showMenuClosure = _.bind(this._showMenu, this);
  44. },
  45. /**
  46. * Adds an event handler
  47. *
  48. * @param {String} eventName event name
  49. * @param {Function} callback
  50. */
  51. on: function(eventName, callback) {
  52. this.$el.on(eventName, callback);
  53. },
  54. /**
  55. * Removes an event handler
  56. *
  57. * @param {String} eventName event name
  58. * @param {Function} callback
  59. */
  60. off: function(eventName, callback) {
  61. this.$el.off(eventName, callback);
  62. },
  63. /**
  64. * Notifies the event handlers
  65. *
  66. * @param {String} eventName event name
  67. * @param {Object} data data
  68. */
  69. _notifyUpdateListeners: function(eventName, data) {
  70. this.$el.trigger(new $.Event(eventName, data));
  71. },
  72. /**
  73. * Merges the actions from the given fileActions into
  74. * this instance.
  75. *
  76. * @param {OCA.Files.FileActions} fileActions instance of OCA.Files.FileActions
  77. */
  78. merge: function(fileActions) {
  79. var self = this;
  80. // merge first level to avoid unintended overwriting
  81. _.each(fileActions.actions, function(sourceMimeData, mime) {
  82. var targetMimeData = self.actions[mime];
  83. if (!targetMimeData) {
  84. targetMimeData = {};
  85. }
  86. self.actions[mime] = _.extend(targetMimeData, sourceMimeData);
  87. });
  88. this.defaults = _.extend(this.defaults, fileActions.defaults);
  89. this.icons = _.extend(this.icons, fileActions.icons);
  90. },
  91. /**
  92. * @deprecated use #registerAction() instead
  93. */
  94. register: function(mime, name, permissions, icon, action, displayName) {
  95. return this.registerAction({
  96. name: name,
  97. mime: mime,
  98. permissions: permissions,
  99. icon: icon,
  100. actionHandler: action,
  101. displayName: displayName || name
  102. });
  103. },
  104. /**
  105. * Register action
  106. *
  107. * @param {OCA.Files.FileAction} action object
  108. */
  109. registerAction: function (action) {
  110. var mime = action.mime;
  111. var name = action.name;
  112. var actionSpec = {
  113. action: function(fileName, context) {
  114. // Actions registered in one FileAction may be executed on a
  115. // different one (for example, due to the "merge" function),
  116. // so the listeners have to be updated on the FileActions
  117. // from the context instead of on the one in which it was
  118. // originally registered.
  119. if (context && context.fileActions) {
  120. context.fileActions._notifyUpdateListeners('beforeTriggerAction', {action: actionSpec, fileName: fileName, context: context});
  121. }
  122. action.actionHandler(fileName, context);
  123. if (context && context.fileActions) {
  124. context.fileActions._notifyUpdateListeners('afterTriggerAction', {action: actionSpec, fileName: fileName, context: context});
  125. }
  126. },
  127. name: name,
  128. displayName: action.displayName,
  129. mime: mime,
  130. filename: action.filename,
  131. order: action.order || 0,
  132. icon: action.icon,
  133. iconClass: action.iconClass,
  134. permissions: action.permissions,
  135. type: action.type || FileActions.TYPE_DROPDOWN,
  136. altText: action.altText || ''
  137. };
  138. if (_.isUndefined(action.displayName)) {
  139. actionSpec.displayName = t('files', name);
  140. }
  141. if (_.isFunction(action.render)) {
  142. actionSpec.render = action.render;
  143. }
  144. if (_.isFunction(action.shouldRender)) {
  145. actionSpec.shouldRender = action.shouldRender;
  146. }
  147. if (!this.actions[mime]) {
  148. this.actions[mime] = {};
  149. }
  150. this.actions[mime][name] = actionSpec;
  151. this.icons[name] = action.icon;
  152. this._notifyUpdateListeners('registerAction', {action: action});
  153. },
  154. /**
  155. * Clears all registered file actions.
  156. */
  157. clear: function() {
  158. this.actions = {};
  159. this.defaults = {};
  160. this.icons = {};
  161. this.currentFile = null;
  162. },
  163. /**
  164. * Sets the default action for a given mime type.
  165. *
  166. * @param {String} mime mime type
  167. * @param {String} name action name
  168. */
  169. setDefault: function (mime, name) {
  170. this.defaults[mime] = name;
  171. this._notifyUpdateListeners('setDefault', {defaultAction: {mime: mime, name: name}});
  172. },
  173. /**
  174. * Returns a map of file actions handlers matching the given conditions
  175. *
  176. * @param {string} mime mime type
  177. * @param {string} type "dir" or "file"
  178. * @param {int} permissions permissions
  179. * @param {string} filename filename
  180. *
  181. * @return {Object.<string,OCA.Files.FileActions~actionHandler>} map of action name to action spec
  182. */
  183. get: function(mime, type, permissions, filename) {
  184. var actions = this.getActions(mime, type, permissions, filename);
  185. var filteredActions = {};
  186. $.each(actions, function (name, action) {
  187. filteredActions[name] = action.action;
  188. });
  189. return filteredActions;
  190. },
  191. /**
  192. * Returns an array of file actions matching the given conditions
  193. *
  194. * @param {string} mime mime type
  195. * @param {string} type "dir" or "file"
  196. * @param {int} permissions permissions
  197. * @param {string} filename filename
  198. *
  199. * @return {Array.<OCA.Files.FileAction>} array of action specs
  200. */
  201. getActions: function(mime, type, permissions, filename) {
  202. var actions = {};
  203. if (this.actions.all) {
  204. actions = $.extend(actions, this.actions.all);
  205. }
  206. if (type) {//type is 'dir' or 'file'
  207. if (this.actions[type]) {
  208. actions = $.extend(actions, this.actions[type]);
  209. }
  210. }
  211. if (mime) {
  212. var mimePart = mime.substr(0, mime.indexOf('/'));
  213. if (this.actions[mimePart]) {
  214. actions = $.extend(actions, this.actions[mimePart]);
  215. }
  216. if (this.actions[mime]) {
  217. actions = $.extend(actions, this.actions[mime]);
  218. }
  219. }
  220. var filteredActions = {};
  221. var self = this;
  222. $.each(actions, function(name, action) {
  223. if (self.allowedPermissions(action.permissions, permissions) &&
  224. self.allowedFilename(action.filename, filename)) {
  225. filteredActions[name] = action;
  226. }
  227. });
  228. return filteredActions;
  229. },
  230. allowedPermissions: function(actionPermissions, permissions) {
  231. return (actionPermissions === OC.PERMISSION_NONE || (actionPermissions & permissions));
  232. },
  233. allowedFilename: function(actionFilename, filename) {
  234. return (!filename || filename === '' || !actionFilename
  235. || actionFilename === '' || actionFilename === filename);
  236. },
  237. /**
  238. * Returns the default file action handler for the given conditions
  239. *
  240. * @param {string} mime mime type
  241. * @param {string} type "dir" or "file"
  242. * @param {int} permissions permissions
  243. *
  244. * @return {OCA.Files.FileActions~actionHandler} action handler
  245. *
  246. * @deprecated use getDefaultFileAction instead
  247. */
  248. getDefault: function (mime, type, permissions) {
  249. var defaultActionSpec = this.getDefaultFileAction(mime, type, permissions);
  250. if (defaultActionSpec) {
  251. return defaultActionSpec.action;
  252. }
  253. return undefined;
  254. },
  255. /**
  256. * Returns the default file action handler for the current file
  257. *
  258. * @return {OCA.Files.FileActions~actionSpec} action spec
  259. * @since 8.2
  260. */
  261. getCurrentDefaultFileAction: function() {
  262. var mime = this.getCurrentMimeType();
  263. var type = this.getCurrentType();
  264. var permissions = this.getCurrentPermissions();
  265. return this.getDefaultFileAction(mime, type, permissions);
  266. },
  267. /**
  268. * Returns the default file action handler for the given conditions
  269. *
  270. * @param {string} mime mime type
  271. * @param {string} type "dir" or "file"
  272. * @param {int} permissions permissions
  273. *
  274. * @return {OCA.Files.FileActions~actionSpec} action spec
  275. * @since 8.2
  276. */
  277. getDefaultFileAction: function(mime, type, permissions) {
  278. var mimePart;
  279. if (mime) {
  280. mimePart = mime.substr(0, mime.indexOf('/'));
  281. }
  282. var name = false;
  283. if (mime && this.defaults[mime]) {
  284. name = this.defaults[mime];
  285. } else if (mime && this.defaults[mimePart]) {
  286. name = this.defaults[mimePart];
  287. } else if (type && this.defaults[type]) {
  288. name = this.defaults[type];
  289. } else {
  290. name = this.defaults.all;
  291. }
  292. var actions = this.getActions(mime, type, permissions);
  293. return actions[name];
  294. },
  295. /**
  296. * Default function to render actions
  297. *
  298. * @param {OCA.Files.FileAction} actionSpec file action spec
  299. * @param {boolean} isDefault true if the action is a default one,
  300. * false otherwise
  301. * @param {OCA.Files.FileActionContext} context action context
  302. */
  303. _defaultRenderAction: function(actionSpec, isDefault, context) {
  304. if (!isDefault) {
  305. var params = {
  306. name: actionSpec.name,
  307. nameLowerCase: actionSpec.name.toLowerCase(),
  308. displayName: actionSpec.displayName,
  309. icon: actionSpec.icon,
  310. iconClass: actionSpec.iconClass,
  311. altText: actionSpec.altText,
  312. hasDisplayName: !!actionSpec.displayName
  313. };
  314. if (_.isFunction(actionSpec.icon)) {
  315. params.icon = actionSpec.icon(context.$file.attr('data-file'), context);
  316. }
  317. if (_.isFunction(actionSpec.iconClass)) {
  318. params.iconClass = actionSpec.iconClass(context.$file.attr('data-file'), context);
  319. }
  320. var $actionLink = this._makeActionLink(params, context);
  321. context.$file.find('a.name>span.fileactions').append($actionLink);
  322. $actionLink.addClass('permanent');
  323. return $actionLink;
  324. }
  325. },
  326. /**
  327. * Renders the action link element
  328. *
  329. * @param {Object} params action params
  330. */
  331. _makeActionLink: function(params) {
  332. return $(OCA.Files.Templates['file_action_trigger'](params));
  333. },
  334. /**
  335. * Displays the file actions dropdown menu
  336. *
  337. * @param {string} fileName file name
  338. * @param {OCA.Files.FileActionContext} context rendering context
  339. */
  340. _showMenu: function(fileName, context) {
  341. var menu;
  342. var $trigger = context.$file.closest('tr').find('.fileactions .action-menu');
  343. $trigger.addClass('open');
  344. menu = new OCA.Files.FileActionsMenu();
  345. context.$file.find('td.filename').append(menu.$el);
  346. menu.$el.on('afterHide', function() {
  347. context.$file.removeClass('mouseOver');
  348. $trigger.removeClass('open');
  349. menu.remove();
  350. });
  351. context.$file.addClass('mouseOver');
  352. menu.show(context);
  353. },
  354. /**
  355. * Renders the menu trigger on the given file list row
  356. *
  357. * @param {Object} $tr file list row element
  358. * @param {OCA.Files.FileActionContext} context rendering context
  359. */
  360. _renderMenuTrigger: function($tr, context) {
  361. // remove previous
  362. $tr.find('.action-menu').remove();
  363. var $el = this._renderInlineAction({
  364. name: 'menu',
  365. displayName: '',
  366. iconClass: 'icon-more',
  367. altText: t('files', 'Actions'),
  368. action: this._showMenuClosure
  369. }, false, context);
  370. $el.addClass('permanent');
  371. },
  372. /**
  373. * Renders the action element by calling actionSpec.render() and
  374. * registers the click event to process the action.
  375. *
  376. * @param {OCA.Files.FileAction} actionSpec file action to render
  377. * @param {boolean} isDefault true if the action is a default action,
  378. * false otherwise
  379. * @param {OCA.Files.FileActionContext} context rendering context
  380. */
  381. _renderInlineAction: function(actionSpec, isDefault, context) {
  382. if (actionSpec.shouldRender) {
  383. if (!actionSpec.shouldRender(context)) {
  384. return;
  385. }
  386. }
  387. var renderFunc = actionSpec.render || _.bind(this._defaultRenderAction, this);
  388. var $actionEl = renderFunc(actionSpec, isDefault, context);
  389. if (!$actionEl || !$actionEl.length) {
  390. return;
  391. }
  392. $actionEl.on(
  393. 'click', {
  394. a: null
  395. },
  396. function(event) {
  397. event.stopPropagation();
  398. event.preventDefault();
  399. if ($actionEl.hasClass('open')) {
  400. return;
  401. }
  402. var $file = $(event.target).closest('tr');
  403. if ($file.hasClass('busy')) {
  404. return;
  405. }
  406. var currentFile = $file.find('td.filename');
  407. var fileName = $file.attr('data-file');
  408. context.fileActions.currentFile = currentFile;
  409. var callContext = _.extend({}, context);
  410. if (!context.dir && context.fileList) {
  411. callContext.dir = $file.attr('data-path') || context.fileList.getCurrentDirectory();
  412. }
  413. if (!context.fileInfoModel && context.fileList) {
  414. callContext.fileInfoModel = context.fileList.getModelForFile(fileName);
  415. if (!callContext.fileInfoModel) {
  416. console.warn('No file info model found for file "' + fileName + '"');
  417. }
  418. }
  419. actionSpec.action(
  420. fileName,
  421. callContext
  422. );
  423. }
  424. );
  425. $actionEl.tooltip({placement:'top'});
  426. return $actionEl;
  427. },
  428. /**
  429. * Trigger the given action on the given file.
  430. *
  431. * @param {string} actionName action name
  432. * @param {OCA.Files.FileInfoModel} fileInfoModel file info model
  433. * @param {OCA.Files.FileList} [fileList] file list, for compatibility with older action handlers [DEPRECATED]
  434. *
  435. * @return {boolean} true if the action handler was called, false otherwise
  436. *
  437. * @since 8.2
  438. */
  439. triggerAction: function(actionName, fileInfoModel, fileList) {
  440. var actionFunc;
  441. var actions = this.get(
  442. fileInfoModel.get('mimetype'),
  443. fileInfoModel.isDirectory() ? 'dir' : 'file',
  444. fileInfoModel.get('permissions'),
  445. fileInfoModel.get('name')
  446. );
  447. if (actionName) {
  448. actionFunc = actions[actionName];
  449. } else {
  450. actionFunc = this.getDefault(
  451. fileInfoModel.get('mimetype'),
  452. fileInfoModel.isDirectory() ? 'dir' : 'file',
  453. fileInfoModel.get('permissions')
  454. );
  455. }
  456. if (!actionFunc) {
  457. actionFunc = actions['Download'];
  458. }
  459. if (!actionFunc) {
  460. return false;
  461. }
  462. var context = {
  463. fileActions: this,
  464. fileInfoModel: fileInfoModel,
  465. dir: fileInfoModel.get('path')
  466. };
  467. var fileName = fileInfoModel.get('name');
  468. this.currentFile = fileName;
  469. if (fileList) {
  470. // compatibility with action handlers that expect these
  471. context.fileList = fileList;
  472. context.$file = fileList.findFileEl(fileName);
  473. }
  474. actionFunc(fileName, context);
  475. },
  476. /**
  477. * Display file actions for the given element
  478. * @param parent "td" element of the file for which to display actions
  479. * @param triggerEvent if true, triggers the fileActionsReady on the file
  480. * list afterwards (false by default)
  481. * @param fileList OCA.Files.FileList instance on which the action is
  482. * done, defaults to OCA.Files.App.fileList
  483. */
  484. display: function (parent, triggerEvent, fileList) {
  485. if (!fileList) {
  486. console.warn('FileActions.display() MUST be called with a OCA.Files.FileList instance');
  487. return;
  488. }
  489. this.currentFile = parent;
  490. var self = this;
  491. var $tr = parent.closest('tr');
  492. var actions = this.getActions(
  493. this.getCurrentMimeType(),
  494. this.getCurrentType(),
  495. this.getCurrentPermissions(),
  496. this.getCurrentFile()
  497. );
  498. var nameLinks;
  499. if ($tr.data('renaming')) {
  500. return;
  501. }
  502. // recreate fileactions container
  503. nameLinks = parent.children('a.name');
  504. nameLinks.find('.fileactions, .nametext .action').remove();
  505. nameLinks.append('<span class="fileactions" />');
  506. var defaultAction = this.getDefaultFileAction(
  507. this.getCurrentMimeType(),
  508. this.getCurrentType(),
  509. this.getCurrentPermissions()
  510. );
  511. var context = {
  512. $file: $tr,
  513. fileActions: this,
  514. fileList: fileList
  515. };
  516. $.each(actions, function (name, actionSpec) {
  517. if (actionSpec.type === FileActions.TYPE_INLINE) {
  518. self._renderInlineAction(
  519. actionSpec,
  520. defaultAction && actionSpec.name === defaultAction.name,
  521. context
  522. );
  523. }
  524. });
  525. function objectValues(obj) {
  526. var res = [];
  527. for (var i in obj) {
  528. if (obj.hasOwnProperty(i)) {
  529. res.push(obj[i]);
  530. }
  531. }
  532. return res;
  533. }
  534. // polyfill
  535. if (!Object.values) {
  536. Object.values = objectValues;
  537. }
  538. var menuActions = Object.values(this.actions.all).filter(function (action) {
  539. return action.type !== OCA.Files.FileActions.TYPE_INLINE;
  540. });
  541. // do not render the menu if nothing is in it
  542. if (menuActions.length > 0) {
  543. this._renderMenuTrigger($tr, context);
  544. }
  545. if (triggerEvent){
  546. fileList.$fileList.trigger(jQuery.Event("fileActionsReady", {fileList: fileList, $files: $tr}));
  547. }
  548. },
  549. getCurrentFile: function () {
  550. return this.currentFile.parent().attr('data-file');
  551. },
  552. getCurrentMimeType: function () {
  553. return this.currentFile.parent().attr('data-mime');
  554. },
  555. getCurrentType: function () {
  556. return this.currentFile.parent().attr('data-type');
  557. },
  558. getCurrentPermissions: function () {
  559. return this.currentFile.parent().data('permissions');
  560. },
  561. /**
  562. * Register the actions that are used by default for the files app.
  563. */
  564. registerDefaultActions: function() {
  565. this.registerAction({
  566. name: 'Download',
  567. displayName: t('files', 'Download'),
  568. order: -20,
  569. mime: 'all',
  570. permissions: OC.PERMISSION_READ,
  571. iconClass: 'icon-download',
  572. actionHandler: function (filename, context) {
  573. var dir = context.dir || context.fileList.getCurrentDirectory();
  574. var isDir = context.$file.attr('data-type') === 'dir';
  575. var url = context.fileList.getDownloadUrl(filename, dir, isDir);
  576. var downloadFileaction = $(context.$file).find('.fileactions .action-download');
  577. // don't allow a second click on the download action
  578. if(downloadFileaction.hasClass('disabled')) {
  579. return;
  580. }
  581. if (url) {
  582. var disableLoadingState = function() {
  583. context.fileList.showFileBusyState(filename, false);
  584. };
  585. context.fileList.showFileBusyState(filename, true);
  586. OCA.Files.Files.handleDownload(url, disableLoadingState);
  587. }
  588. }
  589. });
  590. this.registerAction({
  591. name: 'Rename',
  592. displayName: t('files', 'Rename'),
  593. mime: 'all',
  594. order: -30,
  595. permissions: OC.PERMISSION_UPDATE,
  596. iconClass: 'icon-rename',
  597. actionHandler: function (filename, context) {
  598. context.fileList.rename(filename);
  599. }
  600. });
  601. this.registerAction({
  602. name: 'MoveCopy',
  603. displayName: function(context) {
  604. var permissions = context.fileInfoModel.attributes.permissions;
  605. if (permissions & OC.PERMISSION_UPDATE) {
  606. return t('files', 'Move or copy');
  607. }
  608. return t('files', 'Copy');
  609. },
  610. mime: 'all',
  611. order: -25,
  612. permissions: $('#isPublic').val() ? OC.PERMISSION_UPDATE : OC.PERMISSION_READ,
  613. iconClass: 'icon-external',
  614. actionHandler: function (filename, context) {
  615. var permissions = context.fileInfoModel.attributes.permissions;
  616. var actions = OC.dialogs.FILEPICKER_TYPE_COPY;
  617. if (permissions & OC.PERMISSION_UPDATE) {
  618. actions = OC.dialogs.FILEPICKER_TYPE_COPY_MOVE;
  619. }
  620. var dialogDir = context.dir;
  621. if (typeof context.fileList.dirInfo.dirLastCopiedTo !== 'undefined') {
  622. dialogDir = context.fileList.dirInfo.dirLastCopiedTo;
  623. }
  624. OC.dialogs.filepicker(t('files', 'Choose target folder'), function(targetPath, type) {
  625. if (type === OC.dialogs.FILEPICKER_TYPE_COPY) {
  626. context.fileList.copy(filename, targetPath, false, context.dir);
  627. }
  628. if (type === OC.dialogs.FILEPICKER_TYPE_MOVE) {
  629. context.fileList.move(filename, targetPath, false, context.dir);
  630. }
  631. context.fileList.dirInfo.dirLastCopiedTo = targetPath;
  632. }, false, "httpd/unix-directory", true, actions, dialogDir);
  633. }
  634. });
  635. this.registerAction({
  636. name: 'Open',
  637. mime: 'dir',
  638. permissions: OC.PERMISSION_READ,
  639. icon: '',
  640. actionHandler: function (filename, context) {
  641. let dir, id
  642. if (context.$file) {
  643. dir = context.$file.attr('data-path')
  644. id = context.$file.attr('data-id')
  645. } else {
  646. dir = context.fileList.getCurrentDirectory()
  647. id = context.fileId
  648. }
  649. if (OCA.Files.App && OCA.Files.App.getActiveView() !== 'files') {
  650. OCA.Files.App.setActiveView('files', {silent: true});
  651. OCA.Files.App.fileList.changeDirectory(OC.joinPaths(dir, filename), true, true);
  652. } else {
  653. context.fileList.changeDirectory(OC.joinPaths(dir, filename), true, false, parseInt(id, 10));
  654. }
  655. },
  656. displayName: t('files', 'Open')
  657. });
  658. this.registerAction({
  659. name: 'Delete',
  660. displayName: function(context) {
  661. var mountType = context.$file.attr('data-mounttype');
  662. var type = context.$file.attr('data-type');
  663. var deleteTitle = (type && type === 'file')
  664. ? t('files', 'Delete file')
  665. : t('files', 'Delete folder')
  666. if (mountType === 'external-root') {
  667. deleteTitle = t('files', 'Disconnect storage');
  668. } else if (mountType === 'shared-root') {
  669. deleteTitle = t('files', 'Leave this share');
  670. }
  671. return deleteTitle;
  672. },
  673. mime: 'all',
  674. order: 1000,
  675. // permission is READ because we show a hint instead if there is no permission
  676. permissions: OC.PERMISSION_DELETE,
  677. iconClass: 'icon-delete',
  678. actionHandler: function(fileName, context) {
  679. // if there is no permission to delete do nothing
  680. if((context.$file.data('permissions') & OC.PERMISSION_DELETE) === 0) {
  681. return;
  682. }
  683. context.fileList.do_delete(fileName, context.dir);
  684. $('.tipsy').remove();
  685. // close sidebar on delete
  686. const path = context.dir + '/' + fileName
  687. if (OCA.Files.Sidebar && OCA.Files.Sidebar.file === path) {
  688. OCA.Files.Sidebar.close()
  689. }
  690. }
  691. });
  692. this.setDefault('dir', 'Open');
  693. }
  694. };
  695. OCA.Files.FileActions = FileActions;
  696. /**
  697. * Replaces the button icon with a loading spinner and vice versa
  698. * - also adds the class disabled to the passed in element
  699. *
  700. * @param {jQuery} $buttonElement The button element
  701. * @param {boolean} showIt whether to show the spinner(true) or to hide it(false)
  702. */
  703. OCA.Files.FileActions.updateFileActionSpinner = function($buttonElement, showIt) {
  704. var $icon = $buttonElement.find('.icon');
  705. if (showIt) {
  706. var $loadingIcon = $('<span class="icon icon-loading-small"></span>');
  707. $icon.after($loadingIcon);
  708. $icon.addClass('hidden');
  709. } else {
  710. $buttonElement.find('.icon-loading-small').remove();
  711. $buttonElement.find('.icon').removeClass('hidden');
  712. }
  713. };
  714. /**
  715. * File action attributes.
  716. *
  717. * @todo make this a real class in the future
  718. * @typedef {Object} OCA.Files.FileAction
  719. *
  720. * @property {String} name identifier of the action
  721. * @property {(String|OCA.Files.FileActions~displayNameFunction)} displayName
  722. * display name string for the action, or function that returns the display name.
  723. * Defaults to the name given in name property
  724. * @property {String} mime mime type
  725. * @property {String} filename filename
  726. * @property {int} permissions permissions
  727. * @property {(Function|String)} icon icon path to the icon or function that returns it (deprecated, use iconClass instead)
  728. * @property {(String|OCA.Files.FileActions~iconClassFunction)} iconClass class name of the icon (recommended for theming)
  729. * @property {OCA.Files.FileActions~renderActionFunction} [render] optional rendering function
  730. * @property {OCA.Files.FileActions~actionHandler} actionHandler action handler function
  731. */
  732. /**
  733. * File action context attributes.
  734. *
  735. * @typedef {Object} OCA.Files.FileActionContext
  736. *
  737. * @property {Object} $file jQuery file row element
  738. * @property {OCA.Files.FileActions} fileActions file actions object
  739. * @property {OCA.Files.FileList} fileList file list object
  740. */
  741. /**
  742. * Render function for actions.
  743. * The function must render a link element somewhere in the DOM
  744. * and return it. The function should NOT register the event handler
  745. * as this will be done after the link was returned.
  746. *
  747. * @callback OCA.Files.FileActions~renderActionFunction
  748. * @param {OCA.Files.FileAction} actionSpec action definition
  749. * @param {Object} $row row container
  750. * @param {boolean} isDefault true if the action is the default one,
  751. * false otherwise
  752. * @return {Object} jQuery link object
  753. */
  754. /**
  755. * Display name function for actions.
  756. * The function returns the display name of the action using
  757. * the given context information..
  758. *
  759. * @callback OCA.Files.FileActions~displayNameFunction
  760. * @param {OCA.Files.FileActionContext} context action context
  761. * @return {String} display name
  762. */
  763. /**
  764. * Icon class function for actions.
  765. * The function returns the icon class of the action using
  766. * the given context information.
  767. *
  768. * @callback OCA.Files.FileActions~iconClassFunction
  769. * @param {String} fileName name of the file on which the action must be performed
  770. * @param {OCA.Files.FileActionContext} context action context
  771. * @return {String} icon class
  772. */
  773. /**
  774. * Action handler function for file actions
  775. *
  776. * @callback OCA.Files.FileActions~actionHandler
  777. * @param {String} fileName name of the file on which the action must be performed
  778. * @param context context
  779. * @param {String} context.dir directory of the file
  780. * @param {OCA.Files.FileInfoModel} fileInfoModel file info model
  781. * @param {Object} [context.$file] jQuery element of the file [DEPRECATED]
  782. * @param {OCA.Files.FileList} [context.fileList] the FileList instance on which the action occurred [DEPRECATED]
  783. * @param {OCA.Files.FileActions} context.fileActions the FileActions instance on which the action occurred
  784. */
  785. // global file actions to be used by all lists
  786. OCA.Files.fileActions = new OCA.Files.FileActions();
  787. })();