util.js

"use strict";

/**
 * @desc various utility functions needed by the server
 */

var fs    = require('fs-extra');
var async = require('async');
var Zip   = require('zip-zip-top');


/**
 * @desc  checks if a path exists, and creates it if not
 * @param path:     String or Array of Strings of path(s) to create
 * @param callback: node style callback
 */
exports.createPath = function(path, callback) {
	if (path instanceof Array)
		async.map(path, fs.mkdirs, callback);
	else
		fs.mkdirs(path, callback);
};

/**
 * @desc  creates the necessary paths for a new paper
 * @param parentPath: String path to parent of the new paper (eg. /data/papers/)
 * @param UID:        String of the new paper
 * @param callback:   node style callback
 */
exports.newPaperDir = function(parentPath, UID, callback) {
	var paths = [
		parentPath + '/' + UID + '/tex',
		parentPath + '/' + UID + '/html',
		parentPath + '/' + UID + '/datasets'
	];
	exports.createPath(paths, callback);
};

/*
 * @desc zips the folder where uploaded files are stored
 * @param id the id of publication
 * @param callback node style callback
 */
exports.zipPaper = function(parentPath, id, callback){
	// set path of local folders
	var localpath = parentPath + '/' + id;
	// set target path for .zip
	var zippath = parentPath + '/' + id + '.zip';

	// zip the whole paper folder
	var zip = new Zip();
	zip.zipFolder(localpath, function(err){
		if (err) return callback(err);
		// write zip to target path
		zip.writeToFile(zippath, callback);
	});
};