Activity tab in files sidebar

js/activitycollection.js

@@ -0,0 +1,80 @@
+/*
+ * Copyright (c) 2015
+ *
+ * This file is licensed under the Affero General Public License version 3
+ * or later.
+ *
+ * See the COPYING-README file.
+ *
+ */
+
+(function() {
+
+	OCA.Activity = OCA.Activity || {};
+
+	/**
+	 * @class OCA.Activity.ActivityCollection
+	 * @classdesc
+	 *
+	 * Displays activity information for a given file
+	 *
+	 */
+	var ActivityCollection = OC.Backbone.Collection.extend(
+		/** @lends OCA.Activity.ActivityCollection.prototype */ {
+
+		/**
+		 * Id of the file for which to filter activities by
+		 *
+		 * @var int
+		 */
+		_objectId: null,
+
+		/**
+		 * Type of the object to filter by
+		 *
+		 * @var string
+		 */
+		_objectType: null,
+
+		model: OCA.Activity.ActivityModel,
+
+		/**
+		 * Sets the object id to filter by or null for all.
+		 * 
+		 * @param {int} objectId file id or null
+		 */
+		setObjectId: function(objectId) {
+			this._objectId = objectId;
+		},
+
+		/**
+		 * Sets the object type to filter by or null for all.
+		 * 
+		 * @param {int} objectType file id or null
+		 */
+		setObjectType: function(objectType) {
+			this._objectType = objectType;
+		},
+
+		url: function() {
+			var query = {
+				page: 1,
+				filter: 'all'
+			};
+			var url = OC.generateUrl('apps/activity/activities/fetch');
+			if (this._objectId) {
+				query.objectid = this._objectId;
+				query.filter = 'filter';
+			}
+			if (this._objectType) {
+				query.objecttype = this._objectType;
+				query.filter = 'filter';
+			}
+			url += '?' + OC.buildQueryString(query);
+			return url;
+		}
+	});
+
+	OCA.Activity.ActivityCollection = ActivityCollection;
+})();
+

js/activitymodel.js

@@ -0,0 +1,26 @@
+/*
+ * Copyright (c) 2015
+ *
+ * This file is licensed under the Affero General Public License version 3
+ * or later.
+ *
+ * See the COPYING-README file.
+ *
+ */
+
+(function() {
+	/**
+	 * @class OCA.Activity.ActivityModel
+	 * @classdesc
+	 *
+	 * Displays activity information for a given file
+	 *
+	 */
+	var ActivityModel = OC.Backbone.Model.extend(
+		/** @lends OCA.Activity.ActivityModel.prototype */ {
+	});
+
+	OCA.Activity = OCA.Activity || {};
+	OCA.Activity.ActivityModel = ActivityModel;
+})();
+

js/activitytabview.js

@@ -0,0 +1,161 @@
+/*
+ * Copyright (c) 2015
+ *
+ * This file is licensed under the Affero General Public License version 3
+ * or later.
+ *
+ * See the COPYING-README file.
+ *
+ */
+
+(function() {
+	var TEMPLATE =
+		'<div>' +
+		'{{#if loading}}' +
+		'<div class="loading" style="height: 50px"></div>' +
+		'{{end}}' +
+		'{{else}}' +
+		'<ul>' +
+		'{{#each activities}}' +
+		'    <li class="activity box">' +
+		'        <div class="activity-icon {{typeIconClass}}"></div>' +
+		'        <div class="activitysubject">{{{subject}}}</div>' +
+		'        <span class="activitytime has-tooltip" title="{{formattedDateTooltip}}">{{formattedDate}}</span>' +
+		'        <div class="activitymessage">{{{message}}}</div>' +
+		'        {{#if previews}}' +
+		'        <div class="previews">' +
+		'        {{#each previews}}' +
+		'            <img class="preview {{previewClass}}" src="{{source}}" alt="" />' +
+		'        {{/each}}' +
+		'        </div>' +
+		'        {{/if}}' +
+		'    </li>' +
+		'{{else}}' +
+		'    <li class="empty">{{emptyMessage}}</li>' +
+		'{{/each}}' +
+		'</ul>' +
+		'{{/if}}' +
+		'</div>';
+
+	/**
+	 * Format an activity model for display
+	 *
+	 * @param {OCA.Activity.ActivityModel} activity
+	 * @return {Object}
+	 */
+	function formatActivity(activity) {
+		var output = {
+			subject: activity.get('subjectformatted').markup.trimmed,
+			formattedDate: activity.get('relativeDateTimestamp'),
+			formattedDateTooltip: activity.get('readableDateTimestamp'),
+			message: activity.get('messageformatted').markup.trimmed
+		};
+
+		if (activity.has('typeicon')) {
+			output.typeIconClass = activity.get('typeicon') + ' svg';
+		}
+		if (activity.has('previews')) {
+			output.previews = _.map(activity.get('previews'), function(data) {
+				return {
+					previewClass: data.isMimeTypeIcon ? 'preview-mimetype-icon': '',
+					source: data.source
+				};
+			});
+		}
+		return output;
+	}
+
+	/**
+	 * @class OCA.Activity.ActivityTabView
+	 * @classdesc
+	 *
+	 * Displays activity information for a given file
+	 *
+	 */
+	var ActivityTabView = OCA.Files.DetailTabView.extend(
+		/** @lends OCA.Activity.ActivityTabView.prototype */ {
+		id: 'activityTabView',
+		className: 'activityTabView tab',
+
+		_loading: false,
+
+		initialize: function() {
+			this.collection = new OCA.Activity.ActivityCollection();
+			this.collection.setObjectType('files');
+			this.collection.on('request', this._onRequest, this);
+			this.collection.on('sync', this._onEndRequest, this);
+			this.collection.on('update', this._onChange, this);
+			this.collection.on('error', this._onError, this);
+		},
+
+		template: function(data) {
+			if (!this._template) {
+				this._template = Handlebars.compile(TEMPLATE);
+			}
+			return this._template(data);
+		},
+
+		get$: function() {
+			return this.$el;
+		},
+
+		getLabel: function() {
+			return t('activity', 'Activities');
+		},
+
+		setFileInfo: function(fileInfo) {
+			this._fileInfo = fileInfo;
+			if (this._fileInfo) {
+				this.collection.setObjectId(this._fileInfo.get('id'));
+				this.collection.fetch();
+			} else {
+				this.collection.reset();
+			}
+		},
+
+		_onError: function() {
+			OC.Notification.showTemporary(t('activity', 'Error loading activities'));
+		},
+
+		_onRequest: function() {
+			this._loading = true;
+			this.render();
+		},
+
+		_onEndRequest: function() {
+			this._loading = false;
+			// empty result ?
+			if (!this.collection.length) {
+				// render now as there will be no update event
+				this.render();
+			}
+		},
+
+		_onChange: function() {
+			this._loading = false;
+			this.render();
+		},
+
+		/**
+		 * Renders this details view
+		 */
+		render: function() {
+			if (this._fileInfo) {
+				this.$el.html(this.template({
+					loading: this._loading,
+					activities: this.collection.map(formatActivity),
+					emptyMessage: t('activity', 'No activities')
+				}));
+				this.$el.find('.has-tooltip').tooltip({
+					placement: 'bottom'
+				});
+			} else {
+				// TODO: render placeholder text?
+			}
+		}
+	});
+
+	OCA.Activity = OCA.Activity || {};
+	OCA.Activity.ActivityTabView = ActivityTabView;
+})();
+

js/filesplugin.js

@@ -0,0 +1,22 @@
+/*
+ * Copyright (c) 2015
+ *
+ * This file is licensed under the Affero General Public License version 3
+ * or later.
+ *
+ * See the COPYING-README file.
+ *
+ */
+
+(function(OCA) {
+
+var FilesPlugin = {
+	attach: function(fileList) {
+		fileList.registerTabView(new OCA.Activity.ActivityTabView());
+	}
+};
+
+OC.Plugins.register('OCA.Files.FileList', FilesPlugin);
+
+})(OCA);
+

lib/fileshooksstatic.php

@@ -38,6 +38,9 @@ public static function register() {
 		Util::connectHook('OC_Filesystem', 'delete', 'OCA\Activity\FilesHooksStatic', 'fileDelete');
 		Util::connectHook('\OCA\Files_Trashbin\Trashbin', 'post_restore', 'OCA\Activity\FilesHooksStatic', 'fileRestore');
 		Util::connectHook('OCP\Share', 'post_shared', 'OCA\Activity\FilesHooksStatic', 'share');
+
+		$eventDispatcher = \OC::$server->getEventDispatcher();
+		$eventDispatcher->addListener('OCA\Files::loadAdditionalScripts', ['OCA\Activity\FilesHooksStatic', 'onLoadFilesAppScripts']);
 	}
 
 	/**
@@ -87,4 +90,15 @@ public static function fileRestore($params) {
 	public static function share($params) {
 		self::getHooks()->share($params);
 	}
+
+	/**
+	 * Load additional scripts when the files app is visible
+	 */
+	public static function onLoadFilesAppScripts() {
+		\OCP\Util::addStyle('activity', 'style');
+		\OCP\Util::addScript('activity', 'activitymodel');
+		\OCP\Util::addScript('activity', 'activitycollection');
+		\OCP\Util::addScript('activity', 'activitytabview');
+		\OCP\Util::addScript('activity', 'filesplugin');
+	}
 }

tests/js/activitycollectionSpec.js

@@ -0,0 +1,34 @@
+/*
+ * Copyright (c) 2015
+ *
+ * This file is licensed under the Affero General Public License version 3
+ * or later.
+ *
+ * See the COPYING-README file.
+ *
+ */
+describe('ActivityCollection', function() {
+	var ActivityCollection = OCA.Activity.ActivityCollection;
+
+	describe('query url', function() {
+		it('does not filter by default', function() {
+			var col = new ActivityCollection();
+			expect(col.url())
+				.toEqual(
+					OC.generateUrl('apps/activity/activities/fetch') +
+					'?page=1&filter=all'
+				);
+		});
+		it('filters by id and type when specified', function() {
+			var col = new ActivityCollection();
+			col.setObjectType('files');
+			col.setObjectId(512);
+			expect(col.url())
+				.toEqual(
+					OC.generateUrl('apps/activity/activities/fetch') +
+					'?page=1&filter=filter&objectid=512&objecttype=files'
+				);
+		});
+	});
+});
+