nodebb-plugin-group-gallery 0.0.3

package/.editorconfig

@@ -0,0 +1,8 @@
+root = true
+
+[{*.js, *.css, *.tpl, *.json}]
+indent_style = tab
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = false

package/.gitattributes

@@ -0,0 +1,22 @@
+# Auto detect text files and perform LF normalization
+* text=auto
+
+# Custom for Visual Studio
+*.cs     diff=csharp
+*.sln    merge=union
+*.csproj merge=union
+*.vbproj merge=union
+*.fsproj merge=union
+*.dbproj merge=union
+
+# Standard to msysgit
+*.doc	 diff=astextplain
+*.DOC	 diff=astextplain
+*.docx diff=astextplain
+*.DOCX diff=astextplain
+*.dot  diff=astextplain
+*.DOT  diff=astextplain
+*.pdf  diff=astextplain
+*.PDF	 diff=astextplain
+*.rtf	 diff=astextplain
+*.RTF	 diff=astextplain

package/LICENSE

@@ -0,0 +1,8 @@
+Copyright (c) 2013-2014, psychobunny <psycho.bunny@hotmail.com>
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/README.md

@@ -0,0 +1,3 @@
+# Group Galleries plugin for NodeBB
+
+Exposes photo uploading capability for groups, and introduces a custom widget for placement into group pages

package/lib/comments.js

@@ -0,0 +1,178 @@
+"use strict";
+
+var NodeBB = require('./nodebb'),
+	User = NodeBB.User,
+	Plugins = NodeBB.Plugins,
+	db = NodeBB.db,
+
+	async = require('async'),
+
+	Comments = {};
+
+Comments.addComment = function(imageId, uid, content, callback) {
+	db.incrObjectField('group-gallery', 'nextCommentId', function(err, nextCommentId) {
+		if (err) {
+			callback(err);
+		} else {
+			var comment = {
+				id: nextCommentId,
+				image: imageId,
+				uid: uid,
+				content: content,
+				deleted: 0,
+				timestamp: Date.now()
+			};
+
+			async.parallel([
+				function(next) {
+					db.setObject('group-gallery:comment:' + nextCommentId, comment, next);
+				},
+				function(next) {
+					db.sortedSetAdd('group-gallery:images:' + imageId + ':comments', comment.timestamp, nextCommentId, next)
+				}
+			], function(err) {
+				if (err) {
+					callback(err);
+				} else {
+					getComments([nextCommentId], function(err, comments) {
+						callback(err, comments);
+					});
+				}
+			});
+		}
+	});
+};
+
+Comments.getComments = function(imageId, start, end, callback) {
+	db.getSortedSetRange('group-gallery:images:' + imageId + ':comments', start, end, function(err, ids) {
+		if (err || !ids || !ids.length) {
+			return callback(err, []);
+		}
+
+		getComments(ids, callback);
+	});
+};
+
+Comments.getRawComments = function(ids, callback) {
+	var keys = ids.map(function(id) {
+		return 'group-gallery:comment:' + id;
+	});
+
+	db.getObjects(keys, callback);
+};
+
+function getComments(ids, callback) {
+	var keys = ids.map(function(id) {
+		return 'group-gallery:comment:' + id;
+	});
+
+	db.getObjects(keys, function(err, comments) {
+		if (err) {
+			callback(err);
+			return;
+		}
+
+		var userData, uids = comments.map(function(c) {
+			return parseInt(c.deleted, 10) !== 1 ? parseInt(c.uid, 10) : null;
+		}).filter(function(u, index, self) {
+			return u === null ? false : self.indexOf(u) === index;
+		});
+
+		User.getMultipleUserFields(uids, ['uid', 'username', 'userslug', 'picture'], function(err, usersData) {
+			if (err) {
+				return callback(err);
+			}
+
+			comments = comments.map(function (comment, index) {
+				comment.id = ids[index];
+				return comment;
+			});
+
+			async.map(comments, function(comment, next) {
+				if (parseInt(comment.deleted, 10) === 1) {
+					next();
+					return;
+				}
+
+				userData = usersData[uids.indexOf(parseInt(comment.uid))];
+
+				Comments.parse(comment.content, userData, function(err, s) {
+					comment.user = s.user;
+					comment.content = s.content;
+
+					next(null, comment);
+				});
+			}, function(err, comments) {
+				async.filter(comments, function(item, next) {
+					next(!!item);
+				}, function(result) {
+					callback(err, result);
+				});
+			});
+		});
+	});
+}
+
+Comments.parse = function(message, userData, callback) {
+	Plugins.fireHook('filter:parse.raw', message, function(err, parsed) {
+		callback(null, {
+			user: userData,
+			content: parsed
+		});
+	});
+};
+
+Comments.removeComment = function(uid, commentId, callback) {
+	async.parallel({
+		comment: function(next) {
+			db.getObject('group-gallery:comment:' + commentId, next);
+		},
+		isAdmin: function(next) {
+			User.isAdministrator(uid, next);
+		}
+	}, function(err, result) {
+		if (err) {
+			callback(err);
+			return;
+		}
+
+		if (parseInt(result.comment.uid, 10) === parseInt(uid, 10) || result.isAdmin) {
+			async.parallel([
+				function(next) {
+					db.delete('group-gallery:comment:' + commentId, next);
+				},
+				function(next) {
+					db.sortedSetRemove('group-gallery:images:' + result.comment.image + ':comments', commentId, next);
+				}
+			], callback);
+		} else {
+			callback(new Error('unauthorized'));
+		}
+	});
+};
+
+Comments.editComment = function(uid, commentId, content, callback) {
+	async.parallel({
+		comment: function(next) {
+			db.getObject('group-gallery:comment:' + commentId, next);
+		},
+		isAdmin: function(next) {
+			User.isAdministrator(uid, next);
+		}
+	}, function(err, result) {
+		if (err) {
+			callback(err);
+			return;
+		}
+
+		if (parseInt(result.comment.uit, 10) === parseInt(uid, 10) || result.isAdmin) {
+			db.setObjectField('group-gallery:comment:' + commentId, 'content', content, function(err) {
+				getComments([commentId], callback);
+			});
+		} else {
+			callback(new Error('unauthorized'));
+		}
+	})
+};
+
+module.exports = Comments;

package/lib/config.js

@@ -0,0 +1,47 @@
+"use strict";
+
+var packageInfo = require('../package.json'),
+	pluginInfo = require('../plugin.json'),
+	pluginId = pluginInfo.id.replace('nodebb-plugin-', ''),
+
+	NodeBB = require('./nodebb'),
+	Settings = NodeBB.Settings,
+
+	Config = {};
+
+var adminDefaults = {
+	version: ''
+};
+
+Config.plugin = {
+	name: pluginInfo.name,
+	description: pluginInfo.description,
+	id: pluginId,
+	version: packageInfo.version,
+	icon: 'fa-picture-o'
+};
+
+Config.adminSockets = {
+	sync: function() {
+		Config.global.sync();
+	}
+};
+
+Config.init = function(callback) {
+	Config.global = new NodeBB.Settings(Config.plugin.id, Config.plugin.version, adminDefaults, function() {
+		var oldVersion = Config.global.get('version');
+
+		if (oldVersion < Config.plugin.version) {
+			Config.global.set('version', Config.plugin.version);
+			Config.global.persist(function() {
+				require('./upgrade').doUpgrade(oldVersion, Config.plugin.version, callback);
+			});
+		} else {
+			callback();
+		}
+	});
+};
+
+Config.global = {};
+
+module.exports = Config;

package/lib/gallery.js

@@ -0,0 +1,206 @@
+"use strict";
+
+var NodeBB = require('./nodebb'),
+
+	async = require('async'),
+
+	Gallery = {};
+
+Gallery.addImage = function(params, callback) {
+	if (!params || !params.group || !params.url || !params.uid) {
+		callback(new Error('invalid-data'));
+	} else {
+		var groupSlug = NodeBB.utils.slugify(params.group);
+		NodeBB.db.incrObjectField('group-gallery', 'nextImageId', function(err, nextImageId) {
+			var image = {
+				id: nextImageId,
+				group: groupSlug,
+				caption: params.caption || '',
+				uid: params.uid,
+				url: params.url,
+				timestamp: Date.now(),
+				viewcount: 0
+			};
+
+			async.parallel([
+				function(next) {
+					NodeBB.db.setObject('group-gallery:images:' + nextImageId, image, next);
+				},
+				function(next) {
+					NodeBB.db.sortedSetAdd('group-gallery:group:' + groupSlug + ':images', image.timestamp, nextImageId, next);
+				}
+			], function(err, result) {
+				getImages([nextImageId], callback);
+			});
+		});
+	}
+};
+
+Gallery.removeImage = function(uid, imageId, callback) {
+	async.parallel({
+		image: function(next) {
+			NodeBB.db.getObject('group-gallery:images:' + imageId, next);
+		},
+		isAdmin: function(next) {
+			NodeBB.User.isAdministrator(uid, next);
+		}
+	}, function(err, result) {
+		if (err || !result.image) {
+			callback(err);
+			return;
+		}
+
+		if (parseInt(result.image.uid, 10) === parseInt(uid, 10) || result.isAdmin) {
+			async.parallel([
+				function(next) {
+					NodeBB.db.delete('group-gallery:images:' + imageId, next);
+				},
+				function(next) {
+					NodeBB.db.sortedSetRemove('group-gallery:group:' + result.image.group + ':images', imageId, next);
+				}
+			], callback);
+		}
+	});
+};
+
+Gallery.getGroupImageCount = function(group, callback) {
+	if (!group) {
+		callback(new Error('invalid-data'), []);
+	} else {
+		group = NodeBB.utils.slugify(group);
+
+		NodeBB.db.sortedSetCard('group-gallery:group:' + group + ':images', function(err, result) {
+			callback(err, result ? result : 0);
+		});
+	}
+};
+
+Gallery.getGroupImageCountByUid = function(group, uid, callback) {
+	if (!group || !uid || isNaN(parseInt(uid, 10))) {
+		callback(new Error('invalid-data'), []);
+	} else {
+		group = NodeBB.utils.slugify(group);
+
+		NodeBB.db.getSortedSetRange('group-gallery:group:' + group + ':images', 0, -1, function(err, result) {
+			async.filter(result, function(image, next) {
+				next(parseInt(image.uid, 10) === parseInt(uid, 10));
+			}, function(results) {
+				callback(null, results.length);
+			});
+		});
+	}
+};
+
+Gallery.getImagesByGroupName = function(group, start, end, callback) {
+	if (!group) {
+		callback(new Error('invalid-data'), []);
+	} else {
+		group = NodeBB.utils.slugify(group);
+		start = parseInt(start, 10);
+		end = parseInt(end, 10);
+
+		NodeBB.db.getSortedSetRevRange('group-gallery:group:' + group + ':images',
+			isNaN(start) ? 0 : start, isNaN(end) ? -1 : end, function(err, ids) {
+				if (err) {
+					callback(err, []);
+				} else {
+					getImages(ids, callback);
+				}
+			}
+		);
+	}
+};
+
+Gallery.getImagesByUid = function(group, uid, start, end, callback) {
+	if (!group || !uid || isNaN(parseInt(uid, 10))) {
+		callback(new Error('invalid-data'), []);
+	} else {
+		group = NodeBB.utils.slugify(group);
+		uid = parseInt(uid, 10);
+		start = parseInt(start, 10);
+		end = parseInt(end, 10);
+
+		NodeBB.db.getSortedSetRevRange('group-gallery:group:' + group + ':images',
+			isNaN(start) ? 0 : start, -1, function(err, ids) {
+				if (err) {
+					callback(err, []);
+				} else {
+					getImages(ids, function(err, images) {
+						async.filter(images, function(image, next) {
+							next(parseInt(image.uid, 10) === uid);
+						}, function(results) {
+							callback(null, results.splice(0, end + 1));
+						});
+					});
+				}
+			}
+		);
+	}
+};
+
+Gallery.getImagesByIds = function(ids, callback) {
+	if (!ids || !Array.isArray(ids)) {
+		callback(new Error('invalid-data'), []);
+	} else {
+		getImages(ids, callback);
+	}
+};
+
+function getImages(ids, callback) {
+	var keys = ids.map(function(id) {
+		return 'group-gallery:images:' + id;
+	}), userFields = ['uid', 'username', 'userslug'], uids;
+
+	NodeBB.db.getObjects(keys, function(err, images) {
+		if (err) {
+			callback(err, []);
+		} else {
+			// Get a list of unique uids of the users
+			uids = images.map(function(i) {
+				return i.uid;
+			}).filter(function(uid, index, self) {
+				return self.indexOf(uid) === index;
+			});
+
+			NodeBB.User.getMultipleUserFields(uids, userFields, function(err, usersData) {
+				if (err) return callback(err, []);
+
+				async.map(images, function(image, next) {
+					NodeBB.db.sortedSetCard('group-gallery:images:' + image.id + ':comments', function(err, commentCount) {
+						image.author = usersData[uids.indexOf(parseInt(image.uid, 10))];
+						image.commentcount = commentCount || 0;
+						image.caption = image.caption || 'No caption';
+
+						next(null, image);
+					});
+				}, callback);
+			});
+		}
+	});
+}
+
+Gallery.renameGroup = function(oldName, newName) {
+	async.parallel([
+		function(next) {
+			NodeBB.db.rename(
+				'group-gallery:group:' + NodeBB.utils.slugify(oldName) + ':images',
+				'group-gallery:group:' + NodeBB.utils.slugify(newName) + ':images',
+				next
+			);
+		},
+		function(next) {
+			NodeBB.db.rename(
+				'group-gallery:group:' + NodeBB.utils.slugify(oldName),
+				'group-gallery:group:' + NodeBB.utils.slugify(newName),
+				next
+			);
+		}
+	]);
+
+};
+
+Gallery.increaseViewCount = function(id, callback) {
+	NodeBB.db.incrObjectField('group-gallery:images:' + id, 'viewcount', callback);
+};
+
+module.exports = Gallery;

package/lib/nodebb.js

@@ -0,0 +1,19 @@
+(function(NodeBB) {
+	module.exports = {
+		// NodeBB modules
+		Settings: NodeBB.require('./src/settings'),
+		SocketIndex: NodeBB.require('./src/socket.io/index'),
+		SocketPlugins: NodeBB.require('./src/socket.io/plugins'),
+		SocketAdmin: NodeBB.require('./src/socket.io/admin').plugins,
+		User: NodeBB.require('./src/user'),
+		Groups: NodeBB.require('./src/groups'),
+		Plugins: NodeBB.require('./src/plugins'),
+		UploadsController: NodeBB.require('./src/controllers/uploads'),
+		ControllerHelpers: NodeBB.require('./src/controllers/helpers'),
+		Pagination: NodeBB.require('./src/pagination'),
+		db: NodeBB.require('./src/database'),
+		Templates: NodeBB.require('templates.js'),
+        utils: NodeBB.require('./public/src/utils'),
+		winston: NodeBB.require('winston')
+	}
+})(require.main);

package/lib/sockets.js

@@ -0,0 +1,113 @@
+"use strict";
+
+var NodeBB = require('./nodebb'),
+
+	Comments = require('./comments'),
+	Gallery = require('./gallery'),
+
+	async = require('async'),
+	S = require('string'),
+
+	Sockets = {};
+
+Sockets.removeImage = function(socket, data, callback) {
+	if (socket.uid === 0 || !data || isNaN(parseInt(data.imageId, 10))) {
+		callback(new Error('invalid-data'), []);
+		return;
+	}
+
+	Gallery.removeImage(socket.uid, data.imageId, function(err, result) {
+		if (err) {
+			callback(err);
+			return;
+		}
+
+		NodeBB.SocketIndex.server.sockets.emit('event:group-gallery.removeImage', data.imageId);
+		callback(null, true);
+	});
+};
+
+Sockets.getComments = function(socket, data, callback) {
+	if (socket.uid === 0 || !data || isNaN(parseInt(data.imageId, 10))) {
+		callback(new Error('invalid-data'), []);
+		return;
+	}
+
+	var start = 0, end = -1;
+	Comments.getComments(data.imageId, start, end, callback);
+};
+
+Sockets.addComment = function(socket, data, callback) {
+	if (socket.uid === 0 || !data || isNaN(parseInt(data.imageId, 10))) {
+		callback(new Error('invalid-data'));
+		return;
+	}
+
+	var comment = S(data.comment).stripTags().trim().s;
+	if (comment.length) {
+		async.waterfall([
+			function(next) {
+				Gallery.getImagesByIds([data.imageId], next);
+			},
+			function(image, next) {
+				NodeBB.Groups.isMember(socket.uid, image.group, next);
+			},
+			function(isMember, next) {
+				Comments.addComment(data.imageId, socket.uid, comment, next);
+			}
+		], function(err, result) {
+			if (err) {
+				callback(err);
+				return;
+			}
+
+			NodeBB.SocketIndex.server.sockets.emit('event:group-gallery.newComment', result);
+			callback(null, result);
+		});
+	}
+};
+
+Sockets.removeComment = function(socket, data, callback) {
+	if (socket.uid === 0 || !data || isNaN(parseInt(data.commentId, 10))) {
+		callback(new Error('invalid-data'));
+		return;
+	}
+
+	Comments.removeComment(socket.uid, data.commentId, function(err, result) {
+		if (err) {
+			callback(err);
+			return;
+		}
+
+		NodeBB.SocketIndex.server.sockets.emit('event:group-gallery.removeComment', data.commentId);
+		callback(null, true);
+	});
+};
+
+Sockets.editComment = function(socket, data, callback) {
+	if (socket.uid === 0 || !data || isNaN(parseInt(data.commentId, 10)) || !data.content) {
+		callback(new Error('invalid-data'));
+		return;
+	}
+
+	Comments.editComment(socket.uid, data.commentId, data.content, function(err, result) {
+		if (err) {
+			callback(err);
+			return;
+		}
+
+		NodeBB.SocketIndex.server.sockets.emit('event:group-gallery.editComment', result);
+		callback(null, true);
+	});
+};
+
+Sockets.getRawComment = function(socket, data, callback) {
+	if (socket.uid === 0 || !data || isNaN(parseInt(data.commentId, 10))) {
+		callback(new Error('invalid-data'));
+		return;
+	}
+
+	Comments.getRawComments([data.commentId], callback);
+};
+
+module.exports = Sockets;