nodebb-plugin-group-gallery 0.0.3

package/lib/upgrade.js

@@ -0,0 +1,101 @@
+"use strict";
+
+var pjson = require('../package.json'),
+	async = require('async'),
+	NodeBB = require('./nodebb'),
+
+	Gallery = require('./gallery'),
+
+	Upgrade = {};
+
+Upgrade.doUpgrade = function(oldVersion, newVersion, callback) {
+	var thisVersion;
+
+	async.series([
+		function(next) {
+			thisVersion = '0.0.2';
+
+			if (oldVersion < thisVersion) {
+				getAllImageIds(function(err, ids) {
+					async.each(ids, function(id, next) {
+						async.parallel([
+							function(next) {
+								NodeBB.db.setObjectField('group-gallery:images:' + id, 'caption', '', next);
+							},
+							function(next) {
+								NodeBB.db.setObjectField('group-gallery:images:' + id, 'viewcount', 0, next);
+							},
+							function(next) {
+								NodeBB.db.getSortedSetRevRange('groups:createtime', 0, -1, function(err, groupNames) {
+									async.each(groupNames, function(groupName, next) {
+										groupName = NodeBB.utils.slugify(groupName);
+										async.waterfall([
+											function(next) {
+												NodeBB.db.exists('group-gallery:group:' + groupName + ':images', next);
+											},
+											function(exists, next) {
+												if (err || exists) {
+													next();
+												} else {
+													NodeBB.db.rename(
+														'group-gallery:group:' + groupName,
+														'group-gallery:group:' + groupName + ':images',
+														next
+													);
+												}
+											}
+										], next);
+									}, next);
+								});
+							}
+						], next);
+					}, next);
+				});
+			} else {
+				next();
+			}
+		}
+	], function(err) {
+		if (err) {
+			error(err);
+		} else {
+			done();
+		}
+	});
+
+	function done() {
+		NodeBB.winston.info('[' + pjson.name + '] Upgraded from ' + oldVersion + ' to ' + newVersion);
+		callback();
+	}
+
+	function error(err) {
+		NodeBB.winston.error(err);
+		NodeBB.winston.info('[' + pjson.name + '] No upgrade performed, old version was ' + oldVersion + ' and new version is ' + newVersion);
+		callback();
+	}
+};
+
+function getAllImages(fields, callback) {
+	getAllImageIds(function(err, ids) {
+		if (err || !ids || !ids.length) return callback(err);
+
+		var keys = ids.map(function (id) {
+			return 'group-gallery:images:' + id;
+		});
+
+		NodeBB.db.getObjectsFields(keys, fields, callback);
+	});
+}
+
+function getAllImageIds(callback) {
+	NodeBB.db.getObjectField('group-gallery', 'nextImageId', function(err, result) {
+		var list = [];
+		for (var i = 1, l = parseInt(result, 10); i <= l; i++) {
+			list.push(i);
+		}
+
+		callback(err, list);
+	});
+}
+
+module.exports = Upgrade;

package/library.js

@@ -0,0 +1,258 @@
+"use strict";
+
+var NodeBB = require('./lib/nodebb'),
+	UploadsController = NodeBB.UploadsController,
+	ControllerHelpers = NodeBB.ControllerHelpers,
+
+	Config = require('./lib/config'),
+	Gallery = require('./lib/gallery'),
+
+	async = require('async'),
+
+	GroupGallery = {},
+	app;
+
+GroupGallery.init = function(params, callback) {
+	var router = params.router,
+		middleware = params.middleware,
+		multipartMiddleware = require('connect-multiparty')();
+
+	router.get('/groups/:name/gallery', middleware.checkGlobalPrivacySettings, middleware.buildHeader,
+		groupChecks, renderImages);
+	router.get('/groups/:name/gallery/:image_id', middleware.checkGlobalPrivacySettings, middleware.buildHeader,
+		groupChecks, increaseViewCount, renderSingleImage);
+	router.get('/api/groups/:name/gallery', middleware.checkGlobalPrivacySettings,
+		groupChecks, renderImages);
+	router.get('/api/groups/:name/gallery/:image_id', middleware.checkGlobalPrivacySettings,
+		groupChecks, increaseViewCount, renderSingleImage);
+
+	router.post('/groups/:name/gallery/upload', multipartMiddleware, middleware.applyCSRF,
+		middleware.authenticate, middleware.checkGlobalPrivacySettings, groupChecks, uploadImage);
+
+	NodeBB.SocketAdmin[Config.plugin.id] = Config.adminSockets;
+	NodeBB.SocketPlugins[Config.plugin.id] = require('./lib/sockets');
+
+	app = params.app;
+
+	Config.init(callback);
+};
+
+GroupGallery.defineWidget = function(widgets, callback) {
+	widgets.push({
+		name: Config.plugin.name,
+		widget: Config.plugin.id,
+		description: Config.plugin.description,
+		content: ''
+	});
+
+	callback(null, widgets);
+};
+
+GroupGallery.renderWidget = function(widget, callback) {
+	if (widget.area.template.indexOf('groups') === 0) {
+		var parts = decodeURIComponent(widget.area.url).split('/');
+		if (Array.isArray(parts) && parts.length) {
+			// I have been assured by baris and julian that this is solid enough.
+			var groupName = parts[parts.length - 1];
+			Gallery.getImagesByGroupName(groupName, 0, 2, function(err, images) {
+				app.render('group-gallery/widget', {images: images}, callback);
+			});
+		} else {
+			callback(null, '<div class="alert alert-warning">An error occurred trying to render this widget.</div>');
+		}
+	} else {
+		NodeBB.User.isAdministrator(widget.uid, function(err, isAdmin) {
+			var html = '';
+			if (isAdmin) {
+				html = '<div class="alert alert-warning">The Group Gallery widget only works on group pages. <br><a href="/admin/extend/widgets">&#187; Widget settings</a></a></div>';
+			}
+
+			callback(null, html);
+		});
+	}
+};
+
+GroupGallery.groupRename = function(data) {
+	Gallery.renameGroup(data.old, data.new);
+};
+
+function renderImages(req, res, next) {
+	var imagesPerPage = 4,
+		uid = req.query.uid && req.query.uid.length ? parseInt(req.query.uid, 10) : 0;
+
+	async.waterfall([
+		function(next) {
+			if (!isNaN(uid) && uid > 0) {
+				Gallery.getGroupImageCountByUid(req.params.name, uid, next);
+			} else {
+				Gallery.getGroupImageCount(req.params.name, next);
+			}
+		},
+		function(imageCount, next) {
+			var pageCount = Math.max(1, Math.ceil(imageCount / imagesPerPage));
+
+			if (req.query.page < 1 || req.query.page > pageCount) {
+				return ControllerHelpers.notFound(req, res);
+			}
+
+			var page = parseInt(req.query.page, 10) || 1;
+			var start = (page - 1) * imagesPerPage,
+				end = start + imagesPerPage - 1;
+
+			async.parallel({
+				images: function(next) {
+					if (!isNaN(uid) && uid > 0) {
+						Gallery.getImagesByUid(req.params.name, uid, start, end, next);
+					} else {
+						Gallery.getImagesByGroupName(req.params.name, start, end, next);
+					}
+				},
+				group: function(next) {
+					NodeBB.Groups.getGroupNameByGroupSlug(req.params.name, function(err, groupName) {
+						NodeBB.Groups.get(groupName, {}, next);
+					});
+				}
+			}, function(err, results) {
+				next(err, {
+					pageCount: pageCount,
+					currentPage: page,
+					images: results.images,
+					group: results.group
+				});
+			});
+		}
+	], function(err, data) {
+		data.pagination = NodeBB.Pagination.create(data.currentPage, data.pageCount);
+		res.render('group-gallery/gallery', data);
+	});
+}
+
+function renderSingleImage(req, res, next) {
+	var id = parseInt(req.params.image_id, 10);
+	if (isNaN(id)) {
+		next(new Error('invalid-image'));
+	} else {
+		Gallery.getImagesByIds([id], function(err, image) {
+			if (err || !image.length) {
+				next(new Error('invalid-image'));
+			} else {
+				image = image[0];
+
+				async.parallel({
+					nextImages: function(next) {
+						// Get the next 3 images
+						NodeBB.db.getSortedSetRangeByScore(
+							'group-gallery:group:' + req.params.name + ':images',
+							1, 3, image.timestamp, Date.now(),
+							function(err, result) {
+								Gallery.getImagesByIds(result, next);
+							}
+						);
+					},
+					prevId: function(next) {
+						// Get the previous image
+						NodeBB.db.getSortedSetRangeByScore(
+							'group-gallery:group:' + req.params.name + ':images',
+							0, 0, 0, image.timestamp - 1,
+							function(err, result) {
+								next(null, result.length ? parseInt(result[result.length - 1], 10) : null);
+							}
+						);
+					},
+					group: function(next) {
+						NodeBB.Groups.getGroupNameByGroupSlug(req.params.name, function(err, groupName) {
+							NodeBB.Groups.get(groupName, {}, next);
+						});
+					}
+				}, function(err, result) {
+					if (err) {
+						next(new Error('invalid-image'));
+					} else {
+						result.image = image;
+						result.nextId = result.nextImages.length ? result.nextImages[0].id : null;
+						res.render('group-gallery/single', result);
+					}
+				});
+			}
+		});
+	}
+}
+
+function increaseViewCount(req, res, next) {
+	var id = parseInt(req.params.image_id, 10);
+	if (isNaN(id)) {
+		next(new Error('invalid-image'));
+	} else {
+		Gallery.increaseViewCount(id, function(err, result) {
+			next();
+		});
+	}
+}
+
+function uploadImage(req, res, next) {
+	async.parallel({
+		isAdminOrGlobalMod: function (next) {
+			NodeBB.User.isAdminOrGlobalMod(req.user.uid, next);
+		},
+		isMember: function (next) {
+			NodeBB.Groups.isMember(req.user.uid, req.params.name, next);
+		}
+	}, function(err, results) {
+		if (err) {
+			return next(err);
+		}
+		if (!results.isAdminOrGlobalMod && !results.isMember) {
+			return next(new Error('[[error:no-privileges]]'));
+		}
+		UploadsController.upload(req, res, function(file, next) {
+			var params = JSON.parse(req.body.params);
+			if (params && params.caption && params.caption.length && NodeBB.Plugins.hasListeners('filter:uploadImage')) {
+				NodeBB.Plugins.fireHook('filter:uploadImage', {image: file, uid: req.user.uid}, function(err, data) {
+					if (err) {
+						return next(err);
+					}
+
+					Gallery.addImage({
+						uid: req.user.uid,
+						url: data.url,
+						group: req.params.name,
+						caption: params.caption
+					}, function(err, image) {
+						NodeBB.SocketIndex.server.sockets.emit('event:group-gallery.newImage', image);
+						next(err, data);
+					});
+				});
+			} else {
+				next(new Error('no-upload-plugin'))
+			}
+		}, next);
+	});
+}
+
+function groupChecks(req, res, next) {
+	async.parallel({
+		exists: function (next) {
+			NodeBB.Groups.exists(req.params.name, next);
+		},
+		isHidden: function (next) {
+			NodeBB.Groups.isHidden(req.params.name, next);
+		},
+		isAdminOrGlobalMod: function (next) {
+			NodeBB.User.isAdminOrGlobalMod(req.user.uid, next);
+		},
+		isMember: function (next) {
+			NodeBB.Groups.isMember(req.user.uid, req.params.name, next);
+		}
+	}, function (err, results) {
+		if (err) {
+			return next(err);
+		}
+		if (!results.exists || (results.isHidden && !results.isAdminOrGlobalMod && !results.isMember)) {
+			ControllerHelpers.notFound(req, res);
+			return;
+		}
+		next();
+	});
+}
+
+module.exports = GroupGallery;

package/package.json

@@ -0,0 +1,34 @@
+{
+	"name": "nodebb-plugin-group-gallery",
+	"version": "0.0.3",
+	"description": "Exposes photo uploading capability for groups, and introduces a custom widget for placement into group pages",
+	"main": "library.js",
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/nodebb/nodebb-plugin-group-gallery"
+	},
+	"keywords": [
+		"nodebb",
+		"plugin",
+		"gallery",
+		"photos",
+		"upload"
+	],
+	"author": {
+		"name": "Erik Schamper",
+		"email": "erikschamper@outlook.com"
+	},
+	"license": "MIT",
+	"bugs": {
+		"url": "https://github.com/nodebb/nodebb-plugin-group-gallery/issues"
+	},
+	"readmeFilename": "README.md",
+	"dependencies": {
+		"async": "~0.9.0",
+		"connect-multiparty": "^1.2.4",
+		"string": "^3.0.0"
+	},
+	"nbbpm": {
+		"compatibility": "^0.7.0"
+	}
+}

package/plugin.json

@@ -0,0 +1,30 @@
+{
+	"id": "nodebb-plugin-group-gallery",
+	"name": "Group Galleries",
+	"description": "Exposes photo uploading capability for groups, and introduces a custom widget for placement into group pages",
+	"url": "https://github.com/NodeBB/nodebb-plugin-group-gallery",
+	"library": "./library.js",
+	"hooks": [
+		{ "hook": "static:app.load", "method": "init" },
+		{ "hook": "filter:widgets.getWidgets", "method": "defineWidget" },
+		{ "hook": "filter:widget.render:group-gallery", "method": "renderWidget" },
+		{ "hook": "action:group.rename", "method": "groupRename" }
+	],
+	"staticDirs": {
+		"static": "./static"
+	},
+	"less": [
+		"static/less/style.less"
+	],
+	"css": [
+		"static/vendor/fancybox/jquery.fancybox.css",
+		"static/vendor/fancybox/jquery.fancybox-thumbs.css"
+	],
+	"scripts": [
+		"static/vendor/fancybox/jquery.fancybox.pack.js",
+		"static/vendor/fancybox/jquery.fancybox-thumbs.js",
+		"static/js/main.js",
+		"static/js/lib"
+	],
+	"templates": "static/templates"
+}

package/static/js/lib/comments.js

@@ -0,0 +1,163 @@
+"use strict";
+
+(function(GroupGallery) {
+
+	var Comments = {},
+		currentImageId,
+		socketEvents = {
+			newComment: 'event:group-gallery.newComment',
+			removeComment: 'event:group-gallery.removeComment',
+			editComment: 'event:group-gallery.editComment'
+		};
+
+	Comments.load = function(id) {
+		socket.emit('plugins.group-gallery.getComments', {imageId: id}, function(err, comments) {
+			currentImageId = id;
+			Comments.add(comments);
+		});
+	};
+
+	Comments.add = function(comments) {
+		comments = comments.map(function(el) {
+			el.isMod = parseInt(app.user.uid, 10) === parseInt(el.uid, 10) || app.user.isAdmin;
+			return el;
+		});
+
+		templates.parse('group-gallery/comments', {
+			comments: comments.reverse()
+		}, function(html) {
+			$('.group-gallery-comments').prepend(html);
+		});
+	};
+
+	Comments.send = function(comment) {
+		if (!isNaN(currentImageId)) {
+			socket.emit('plugins.group-gallery.addComment', {
+				imageId: currentImageId,
+				comment: comment
+			});
+		}
+	};
+
+	Comments.remove = function(id) {
+		if (!isNaN(parseInt(id, 10))) {
+			socket.emit('plugins.group-gallery.removeComment', {
+				commentId: id
+			});
+		}
+	};
+
+	Comments.edit = function(id, content) {
+		if (!isNaN(parseInt(id, 10))) {
+			socket.emit('plugins.group-gallery.getRawComment', {commentId: id}, function(err, result) {
+				var commentEl = $('[data-comment-id="' + id + '"]'),
+					el = commentEl.find('.group-gallery-comment-content'),
+					current = result[0].content,
+					currentHtml = el.html();
+
+				commentEl.find('.group-gallery-comment-options').hide();
+				el.html(
+					'<div class="form-group">' +
+					'<input id="group-gallery-comment-input-edit" type="text" class="form-control" value="' + current + '">' +
+					'</div>')
+					.on('keypress.group-gallery', '#group-gallery-comment-input-edit', function(e) {
+						if (e.which === 13 && !e.shiftKey) {
+							socket.emit('plugins.group-gallery.editComment', {
+								commentId: id,
+								content: e.currentTarget.value
+							});
+							cleanup();
+						} else if (e.which === 0) {
+							cancel();
+						}
+					});
+
+				function cleanup() {
+					el.off('keypress.edit', '#group-gallery-comment-input-edit');
+					commentEl.find('.group-gallery-comment-options').show();
+				}
+
+				function cancel() {
+					el.html(currentHtml);
+					cleanup();
+				}
+			});
+		}
+	};
+
+	Comments.clear = function() {
+		$('.group-gallery-comments').html('');
+		currentImageId = null;
+	};
+
+	Comments.bindEvents = function() {
+		var commentInput = $('#group-gallery-comment-input'),
+			commentButton = $('[data-func="group-gallery.comment"]'),
+			commentsDiv = $('.group-gallery-comments'),
+			editCommentButtonSelector = '[data-func="group-gallery.comment.edit"]',
+			removeCommentButtonSelector = '[data-func="group-gallery.comment.remove"]';
+
+		commentInput.on('keypress.group-gallery', function(e) {
+			if (e.which === 13 && !e.shiftKey) {
+				Comments.send(commentInput.val());
+				commentInput.val('');
+			}
+		});
+
+		commentButton.on('click.group-gallery', function(e){
+			Comments.send(commentInput.val());
+			commentInput.val('');
+			return false;
+		});
+
+		commentsDiv.on('click.group-gallery', editCommentButtonSelector, function(e) {
+			var commentId = $(e.currentTarget).parents('[data-comment-id]').data('commentId');
+			Comments.edit(commentId);
+
+			e.preventDefault();
+			return false;
+		});
+
+		commentsDiv.on('click.group-gallery', removeCommentButtonSelector, function(e) {
+			var commentId = $(e.currentTarget).parents('[data-comment-id]').data('commentId');
+			Comments.remove(commentId);
+
+			e.preventDefault();
+			return false;
+		});
+
+		socket.on(socketEvents.newComment, function(data) {
+			if (parseInt(data[0].image, 10) === currentImageId) {
+				Comments.add(data);
+			}
+		});
+
+		socket.on(socketEvents.removeComment, function(id) {
+			$('[data-comment-id="' + id + '"]').remove();
+		});
+
+		socket.on(socketEvents.editComment, function(data) {
+			var comment = data[0];
+			$('[data-comment-id="' + comment.id + '"] .group-gallery-comment-content').html(comment.content);
+		});
+	};
+
+	Comments.unbindEvents = function() {
+		var commentInput = $('#group-gallery-comment-input'),
+			commentButton = $('[data-func="group-gallery.comment"]'),
+			commentsDiv = $('.group-gallery-comments'),
+			editCommentButtonSelector = '[data-func="group-gallery.comment.edit"]',
+			removeCommentButtonSelector = '[data-func="group-gallery.comment.remove"]';
+
+		commentInput.off('keypress.group-gallery');
+		commentButton.off('click.group-gallery');
+		commentsDiv.off('click.group-gallery', editCommentButtonSelector);
+		commentsDiv.off('click.group-gallery', removeCommentButtonSelector);
+
+		socket.off(socketEvents.newComment);
+		socket.off(socketEvents.removeComment);
+	};
+
+	GroupGallery.comments = Comments;
+
+})(GroupGallery);

package/static/js/lib/modal.js

@@ -0,0 +1,111 @@
+"use strict";
+
+(function(GroupGallery) {
+
+	var socketEvents = {
+			removeImage: 'event:group-gallery.removeImage'
+		},
+
+		Modal = {};
+
+	Modal.open = function(event) {
+		var el = $(event.currentTarget),
+			id = el.data('group-gallery-id'),
+			index = parseInt(GroupGallery.vars.indexLookup[id], 10);
+
+		Modal.openOnIndex(index);
+
+		event.preventDefault();
+		return false;
+	};
+
+	Modal.openOnIndex = function(index) {
+		GroupGallery.vars.lightboxOptions.index = isNaN(index) || index < 0 ? 0 : index;
+		GroupGallery.vars.lightboxOptions.beforeShow = beforeShow;
+		GroupGallery.vars.lightboxOptions.afterShow = afterShow;
+		GroupGallery.vars.lightboxOptions.beforeClose = beforeClose;
+		$.fancybox(GroupGallery.vars.lightboxImages, GroupGallery.vars.lightboxOptions);
+	};
+
+	function beforeShow() {
+		GroupGallery.comments.clear();
+	}
+
+	function afterShow() {
+		var id = parseInt(GroupGallery.vars.idLookup[this.index], 10);
+		if (!isNaN(id)) {
+			var _setDimension = $.fancybox._setDimension;
+			$.fancybox._setDimension = function() {
+				_setDimension();
+				GroupGallery.comments.load(id);
+				$.fancybox._setDimension = _setDimension;
+			};
+
+			unbindEvents.apply(this);
+			bindEvents.apply(this, [id]);
+		}
+	}
+
+	function beforeClose() {
+		unbindEvents.apply(this);
+	}
+
+	function removeImage(id) {
+		if (!isNaN(id)) {
+			socket.emit('plugins.group-gallery.removeImage', {imageId: id});
+		}
+	}
+
+	function bindEvents(id) {
+		var removeImageButton = $('[data-func="group-gallery.remove"]'),
+			self = this;
+
+		if (parseInt(GroupGallery.vars.groupImages[this.index].uid, 10) === parseInt(app.user.uid, 10) || app.user.isAdmin) {
+			removeImageButton.removeClass('hidden');
+		} else {
+			removeImageButton.addClass('hidden');
+		}
+
+        removeImageButton.on('click.group-gallery', function(e) {
+            removeImage.apply(self, [id]);
+
+            e.preventDefault();
+            return false;
+        });
+
+		socket.on(socketEvents.removeImage, function(imageId) {
+			var index = GroupGallery.vars.indexLookup[parseInt(imageId, 10)];
+
+			if (!isNaN(index)) {
+				// Remove image from the image list, reindex them
+				GroupGallery.vars.groupImages.splice(index, 1);
+				GroupGallery.indexImages();
+				self.group.splice(index, 1);
+
+				if (parseInt(imageId, 10) === id) {
+					if (self.group.length < 1) {
+						$.fancybox.close();
+					} else {
+						// We also removed it from the fancybox list, so the same index will be the next image
+						$.fancybox.jumpto(index);
+					}
+				}
+			}
+		});
+
+		GroupGallery.comments.bindEvents();
+	}
+
+	function unbindEvents() {
+		var	removeImageButton = $('[data-func="group-gallery.remove"]');
+
+		removeImageButton.off('click.group-gallery');
+
+		socket.off(socketEvents.removeImage);
+
+		GroupGallery.comments.unbindEvents();
+	}
+
+	GroupGallery.modal = Modal;
+
+})(GroupGallery);