server photo

Receive and manipulate user submitted photos.

Photo = require 'photo'
Db = require 'db'

exports.onPhoto = (info) !->
	newInfo = Photo.crop {left: 100, right: 100, top: 100, bottom: 100}
	Db.shared.set 'myPhotoKey', newInfo.key

This module (only) works in unison with the photo client module. Check that page for a more extensive walkthrough.

Events

onPhoto(info,claimArg)

Invoked when a photo is both claimed and uploaded. The info object will have the same fields as returned from the get(key) function.

Return false to discard the photo. Otherwise, the return value is stored in the photo's data field, included in the info object.

Functions

get(key)

Gets photo info array for given key. The info array contains the following fields:

Key	Value
key	Photo key; when the key is known, users can view the image.
type	Image type. Maps to the values returned by PHP's imageTypes().
userId	User id of the Happening member that submitted the photo. Can be 0.
width	Unscaled image width.
height	Unscaled image height.
size	File size of the unscaled image.
data	Custom data returned by onPhoto after claiming the photo.

list(userId?)

List of all photos uploaded to this plugin. When userId is supplied, the list is filtered to only match photos for this user.

delete(photoKey)

Delete photo original and all scaled versions.

claim(opts)

Given a opts.guid (which was obtained client-side), claim the photo for this plugin and fire a callback. The latter only happens after the photo has been fully received and processed - which may be never: an unfulfilled claim is discarded after a couple of days. opts consists of: | guid | Identifier for the upload we are claiming. | | url | When an URL is given instead of guid, the image will be downloaded from this URL. Specifying a cb is required in this case. It will be called with null instead of the photo info object on failure. | | cb | Array, where the first element is a server-side method name, and the rest are optional arguments. The photo info object is appended as the last argument. When the cb key is not set, the legacy form onPhoto(infoHash) will be called. | | memberId | Which group member to attribute this photo to. If not set and we're called as a user RPC, the calling member is assumed. |