//v0.1 - o9/2o14
//- initial
//v0.1.1
//- support for automatic updates/scriptwizard
//v0.2
//- new option "PATH" to choose items from any folder
//- new option "SETENVVAR" the given env-var will contain item-paths
//- new option "SETTABVAR" the given tab-var will contain item-paths
//v0.3
//- new option "NAME" to filter items by name/extension (regular expression)
//- new option "RECURSE" recursive mode, meant to be used with PATH
//- new option "JSFILTER" for custom scripting filter logic
//- new option "MINSIZE" to filter files by minimum file size
//- new option "MAXSIZE" to filter files by maximum file size
//- new option "MAXSIZETOTAL" to limit total size
//- new option "COPYTOCOLL" to copy results to a file collection
//- new switch "ECHO" to output results to the console for easier testing

//todo:
//- put result into txtfile?

///////////////////////////////////////////////////////////////////////////////
function OnInit(data){
	//uid added via script wizard (do not change after publishing this script)
	var uid = "18C9CF48-05DB-4B9F-B293-9F5D692C266A";
	//resource center url added via script wizard (required for updating)
	var url = "http://resource.dopus.com/viewtopic.php?f=35&t=23142";
	data.name = "Command.Generic: SelectRandom";
	data.desc = "Randomly retrieve/select a (random) number of items.";
	data.copyright = "tbone";
	data.version = "0.3";
	data.default_enable = true;
	data.min_version = "11";

	var cmd = data.AddCommand();
	cmd.name = "SelectRandom"
	cmd.method = "Command_SelectRandom";
	cmd.desc = data.desc;
	cmd.template = "PATH/K,RECURSE/S,SETTABVAR/K,SETENVVAR/K,FOLDERS/S,FILES/S,NODESELECT/S,RANDOM/S,SINGLEFOLDER/S,SINGLEFOLDERMINCOUNT/K,ITEMCOUNT/K,ITEMCOUNTPERC/K,ACTION/K,NAME/K,MINSIZE/K,MAXSIZE/K,MAXSIZETOTAL/K,JSFILTER/K,ECHO/S,COPYTOCOLL/K,COMMANDS/R";
	///////////////////////////////////////////////////////////////////////////
	function ConfigHelper(data){
		this.data=data; this.descriptions=null; this.last=null;
		this.add = function(name, val, description){
			this.data.config[name]=val; this.last=[this.data.config[name],name];
			if (description!=undefined) this.des(description); return this;}
		this.des = function(description){
			if (!(description && DOpus.version.AtLeast("11.6.1"))) return this;
			if (!this.descriptions){ this.descriptions=DOpus.NewMap();
				data.config._descriptions=this.descriptions; }
			this.descriptions(this.last[1])=description; return this;}
		this.val = function(val){
			if (typeof this.last[0]=="object") this.last[0].push_back(val);
			else this.last[0]=val; return this;}
	}
	///////////////////////////////////////////////////////////////////////////
	var cfg = new ConfigHelper(data);
	cfg.add("DebugOutput",			false).
		des("Enable debug output in the script console.");
}
///////////////////////////////////////////////////////////////////////////////
var COMMAND_ABORTED = true;
var COMMAND_SUCCEEDED = false;
///////////////////////////////////////////////////////////////////////////////
function Command_SelectRandom(data){
	Debug("SelectRandom():");
	var fso = new ActiveXObject("Scripting.FilesystemObject");

	var params = {
		path			: GetParameter(data, "PATH", null, false),
		recurse			: GetParameter(data, "RECURSE", null, false),
		setTabVar		: GetParameter(data, "SETTABVAR", null, ""),
		setEnvVar		: GetParameter(data, "SETENVVAR", null, ""),
		folders			: GetParameter(data, "FOLDERS", null, null),
		files			: GetParameter(data, "FILES", null, null),
		noDeselect		: GetParameter(data, "NODESELECT", null, false),
		random			: GetParameter(data, "RANDOM", null, false),
		singleFol		: GetParameter(data, "SINGLEFOLDER", null, false),
		singleFolMin	: GetParameter(data, "SINGLEFOLDERMINCOUNT", null, 1),
		action			: GetParameter(data, "ACTION", null, ""),
		itemCount		: GetParameter(data, "ITEMCOUNT", null, 1),
		itemCountPerc	: GetParameter(data, "ITEMCOUNTPERC", null, null),
		commands		: GetParameter(data, "COMMANDS", null, ""),
		name			: GetParameter(data, "NAME", null, null),
		minSize			: GetParameter(data, "MINSIZE", null, null),
		maxSize			: GetParameter(data, "MAXSIZE", null, null),
		maxSizeTotal	: GetParameter(data, "MAXSIZETOTAL", null, null),
		jsFilter		: GetParameter(data, "JSFILTER", null, null),
		copyToColl		: GetParameter(data, "COPYTOCOLL", null, null),
		echo			: GetParameter(data, "ECHO", null, false)
	}
	///////////////////////////////////////////////////////////////////////////
	function FriendlySizeToBytes(friendlySize){
		var size = parseFloat(friendlySize=friendlySize.toLowerCase());
		if (isNaN(size)) return null;
		if (friendlySize.match(/(\d|\s)(b|bytes?)$/)) ;
		else if (friendlySize.match(/(kb|kilobytes?)$/)) size*=1024;
		else if (friendlySize.match(/(mb|megabytes?)$/)) size*=1024*1024;
		else if (friendlySize.match(/(gb|gigabytes?)$/)) size*=1024*1024*1024;
		else if (friendlySize.match(/(tb|terabytes?)$/)) size*=1024*1024*1024*1024;
		else if (friendlySize.match(/(pb|petabytes?)$/)) size*=1024*1024*1024*1024*1024;
		else if (friendlySize.match(/(eb|exabytes?)$/)) size*=1024*1024*1024*1024*1024*1024;
		else size = null;
		return size;
	}
	///////////////////////////////////////////////////////////////////////////
	function Filter( item, itemSize, nameWild, minSize, maxSize, file, folder, jsFilter){
		if (nameWild && !nameWild.Match(item.name)) return "name";
		if (minSize!==null && minSize>itemSize) return "minsize"; //(!item.is_dir || (item.is_dir && item.got_size))
		if (maxSize!=null &&  maxSize<itemSize) return "maxsize"; //(!item.is_dir || (item.is_dir && item.got_size))
		//if (file!==null && item.is_dir!==false) { DOpus.Output("File:" + file + ", " + item.is_dir); return "file";}
		//if (folder!==null && item.is_dir!==true) return "folder";
		if (jsFilter!==null){
			try{
				var SRFilter = new Function("item", jsFilter);
				if (SRFilter(item)!==false) return "jsfilter";
			} catch(e){
				DOpus.Output("E   JSFilter failed: " + e);
				return "jsfilter";
			}
		}
		return false;
	}
	///////////////////////////////////////////////////////////////////////////
	function AddItemWithFilter(item, itemSize, filteredItemCollections, params){
		var filRes = Filter(item, itemSize, params.name, params.minSize, params.maxSize, params.files, params.folders, params.jsFilter);
		if (filRes)	return false;
		filteredItemCollections.all.push_back(item);
		if (item.is_dir) filteredItemCollections.dirs.push_back(item);
		else filteredItemCollections.files.push_back(item);
		return true;
	}
	///////////////////////////////////////////////////////////////////////////
	function RegexToWildcardObj(regex){
		if (regex) return DOpus.FSUtil.NewWild(regex,"rf");
		return null;
	}
	///////////////////////////////////////////////////////////////////////////
	function ValidateSizeParameter( paramName, paramValue){
		if (paramValue!==null && (paramValue=FriendlySizeToBytes(paramValue))==null){
			Debug("W   "+paramName+" malformed.");
			return null;
		}
		return paramValue;
	}
	///////////////////////////////////////////////////////////////////////////
	function GetFilteredItemCollections(data, params){
		var filteredItemCollections = {	all		: DOpus.Create.Vector(),
										files	: DOpus.Create.Vector(),
										dirs	: DOpus.Create.Vector()};
		if (params.path){
			if (!DOpus.FSUtil.Exists(params.path))
				throw "Path ["+params.path+"] not found";
			var iEnum = DOpus.FSUtil.ReadDir(params.path, params.recurse);
			if (iEnum.error!=0 && iEnum.error!=18 && iEnum.error!=2 ) //18 = empty folder, 2=drive root
				throw "ReadDir ["+folderpath+"] failed, fEnum.error ["+iEnum.error+"]";
			while (!iEnum.complete){
				var item = iEnum.next(), itemSize = item.size.cy*10000;
				if ((params.minSize!==null || params.maxSize!==null || params.maxSizeTotal) &&
					item.is_dir && !item.got_size) itemSize = GetFolderSize(item.realpath);
				AddItemWithFilter(item, itemSize, filteredItemCollections, params);
			}
		} else {
			for (var iEnum = new Enumerator(data.func.sourcetab.all); !iEnum.atEnd();){
				var item = iEnum.item(), itemSize = item.size.cy*10000; iEnum.moveNext();
				if ((params.minSize!==null || params.maxSize!==null || params.maxSizeTotal) &&
					item.is_dir && !item.got_size) itemSize = GetFolderSize(item.realpath);
				AddItemWithFilter(item, itemSize, filteredItemCollections, params);
			}
		}
		return filteredItemCollections;
	}
	///////////////////////////////////////////////////////////////////////////
	function SetResultVariables(data, params, value){
		if (params.setTabVar) data.func.sourcetab.vars.Set(params.setTabVar, value);
		if (params.setEnvVar){ var EM = new EnvMagic(); EM.Set(params.setEnvVar, value); }
	}
	///////////////////////////////////////////////////////////////////////////
	function PickItemsRandomly(data, items, maxItems, maxSizeTotal){
		Debug("    Picking items..");
		var cmd = data.func.command; cmd.ClearFiles();
		var randomsUsed = { "dummy":true };
		var sizeTotal = 0;
		var r = "dummy";
		for (var i=0;i<maxItems && items.count;i++){
			r = Math.floor((Math.random()*items.count));
			var item = items(r), itemSize = item.size.cy*10000;
			if (item.is_dir && !item.got_size) itemSize = GetFolderSize(item.realpath);
			items.erase(r);
			if (maxSizeTotal){
				if (((sizeTotal+itemSize)>maxSizeTotal)) {
					i--;
					continue;
				}
			}
			sizeTotal+=itemSize;
			cmd.AddFile(item);
		}
		return cmd;
	}
	///////////////////////////////////////////////////////////////////////////
	function GetNumberOfItemsToSelect(params, items){
		if (params.itemCountPerc && !isNaN(parseInt(params.itemCountPerc,10))) {
			params.itemCountPerc = parseInt(params.itemCountPerc);
			if (params.itemCountPerc>0)
				params.itemCount = items.count*(params.itemCountPerc/100);
		}
		if (params.itemCount > items.count) params.itemCount = items.count;
		if (params.random){
			if (params.itemCount>1)
				params.itemCount = Math.floor((Math.random()*params.itemCount)+1);
			else
				params.itemCount = Math.floor((Math.random()*items.count)+1);
		}
		return params.itemCount;
	}
	///////////////////////////////////////////////////////////////////////////
	function ItemCollectionToCSVLine(collection, separator){
		separator = separator || ";"
		var itemsSeparated = "";
		for (var iEnum = new Enumerator(collection); !iEnum.atEnd();){
			var item = iEnum.item(); iEnum.moveNext();
			itemsSeparated += item.realpath + (!iEnum.atEnd()?separator:"");
		}
		return itemsSeparated;
	}
	///////////////////////////////////////////////////////////////////////////
	function GetCollectionToPickFrom(filteredItemCollections, params){
		if (params.singleFol && (params.singleFolMin <= filteredItemCollections.dirs.count)){
			params.random = false;
			params.itemCount = 1;
			params.itemCountPerc = null;
			return filteredItemCollections.dirs;
		}
		if (params.folders && !params.files)	return filteredItemCollections.dirs;
		if (params.files  && !params.folders)	return filteredItemCollections.files;
		return filteredItemCollections.all;
	}
	///////////////////////////////////////////////////////////////////////////
	function SelectItemsInFiledisplay(data, params, cmd){
		if (!params.path){
			DOpus.Output("    Selecting items..");
			cmd.RunCommand("Select FROMSCRIPT EXACT"+(!params.noDeselect?" DESELECTNOMATCH":""));
			return true;
		}
		return false;
	}
	///////////////////////////////////////////////////////////////////////////
	function SetReturnStringOfItems(data, params, cmd){
		if (params.setTabVar || params.setEnvVar){
			SetResultVariables(data, params, ItemCollectionToCSVLine(cmd.files, ";"));
			return true;
		}
		return false;
	}
	///////////////////////////////////////////////////////////////////////////
	function TriggerFileTypeActions(params, cmd){
		if (params.action){
			Debug("    Triggering action ["+params.action+"]..");
			cmd.RunCommand("FileType ACTION="+params.action);
			return true;
		}
		return false;
	}
	///////////////////////////////////////////////////////////////////////////
	function ExecuteCommands(params, cmd){
		if (params.commands){
			Debug("    Running commands..");
			var commands = params.commands.split("\\n");
			for(var c=0;c<commands.length;c++){
				Debug("        Cmd: " + commands[c]);
				cmd.RunCommand(commands[c]);
			}
			return true;
		}
		return false;
	}
	///////////////////////////////////////////////////////////////////////////
	function EchoItemsToConsole(params, cmd){
		if (params.echo){
			DOpus.Output("Items ("+cmd.files.count+"):");
			for (var iEnum = new Enumerator(cmd.files); !iEnum.atEnd();){
				var item = iEnum.item(); iEnum.moveNext();
				DOpus.Output(item.realpath);
			}
			return true;
		}
		return false;
	}
	///////////////////////////////////////////////////////////////////////////
	function CopyToCollection(params, cmd){
		if (params.copyToColl!==null){
			DOpus.Output("    Copying to collection ["+params.copyToColl+"]..");
			var cmdCol = DOpus.Create.Command();
			cmdCol.AddLine('CreateFolder "coll://'+params.copyToColl+'"');
			cmdCol.AddLine('Copy COPYTOCOLL=member TO "coll://'+params.copyToColl+'"');
			var addedItems = false;
			for (var iEnum = new Enumerator(cmd.files); !iEnum.atEnd();){
				var item = iEnum.item(); iEnum.moveNext();
				if (!DOpus.FSUtil.Exists("coll://"+params.copyToColl+"/"+item.name)){
					cmdCol.AddFile(item);
					addedItems = true;
				}
			}
			//as selected files in source will be used instead (bug?)
			//issue: http://resource.dopus.com/viewtopic.php?f=3&t=24406
			if (addedItems) cmdCol.Run();
			return true;
		}
		return false;
	}
	///////////////////////////////////////////////////////////////////////////
	function GetFolderSize(path){
		var size = fso.GetFolder(path).Size;
		if (!isNaN(parseInt(size,10))) return size;
		return null;
	}
	///////////////////////////////////////////////////////////////////////////
	params.name					= RegexToWildcardObj( params.name);
	params.minSize				= ValidateSizeParameter("MinSize", params.minSize);
	params.maxSize				= ValidateSizeParameter("MaxSize", params.maxSize);
	params.maxSizeTotal			= ValidateSizeParameter("MaxSizeTotal", params.maxSizeTotal);

	PrintParams(params);

	var filteredItemCollections	= GetFilteredItemCollections(data, params);
	var filteredItemCollection	= GetCollectionToPickFrom(filteredItemCollections, params);

	if (filteredItemCollection.count==0){
		SetResultVariables(data, params, "");
		Debug("I   No items, aborting");
		return COMMAND_ABORTED;
	}

	params.itemCount			= GetNumberOfItemsToSelect(params, filteredItemCollection);
	var pickedItemsCommand		= PickItemsRandomly(data, filteredItemCollection, params.itemCount, params.maxSizeTotal);
	var voidItemsCopied			= CopyToCollection(params, pickedItemsCommand); //if copytocoll given
	var voidItemsReturned		= SetReturnStringOfItems(data, params, pickedItemsCommand); //if variable names given
	var voidItemsSelected		= SelectItemsInFiledisplay(data, params, pickedItemsCommand); //if no path given
	var voidActionsTriggered	= TriggerFileTypeActions(params, pickedItemsCommand); //if action given
	var voidCommandsExecuted	= ExecuteCommands(params, pickedItemsCommand); //if commands given
	var voidItemsEchoed			= EchoItemsToConsole(params, pickedItemsCommand); //if echo enabled

	Debug("Done.");
	return COMMAND_SUCCEEDED;
}
///////////////////////////////////////////////////////////////////////////////
function EnvMagic(scope){ //v0.1
	this.scope = scope || "Process";
	try{this.shell=shell} catch(e){this.shell=new ActiveXObject("WScript.Shell")};
	this.env = this.shell.Environment(this.scope);
	///////////////////////////////////////////////////////////////////////////
	this.Set = function (varname, value, scope){
		var env = scope?this.shell.Environment(scope):this.env;
		env(varname) = value;
		return value;
	}
	///////////////////////////////////////////////////////////////////////////
	this.Get = function (varname, scope){
		var env = scope?this.shell.Environment(scope):this.env;
		return env(varname);
	}
	///////////////////////////////////////////////////////////////////////////
	this.Remove = function (varname, scope){
		var env = scope?this.shell.Environment(scope):this.env;
		return env.Remove(varname);
	}
	///////////////////////////////////////////////////////////////////////////
	this.Expand = function (varString){
		return this.shell.ExpandEnvironmentStrings(varString);
	}
}
///////////////////////////////////////////////////////////////////////////////
function PrintParams( params){
	var maxLen = 0;
	for(param in params) if (param.length > maxLen)	maxLen = param.length;
	for(param in params){
		var pad = ""; while (pad.length+param.length<maxLen) pad+=" ";
		Debug("    "+param.toUpperCase()+pad+": "+params[param]);
	}
}
///////////////////////////////////////////////////////////////////////////////
function GetParameter( data, templateName, configName, defaultValue){
	// v0.8
	function VectorToArray(vector){
		var a = new Array();
		for(var v=0;v<vector.length;v++)
			a[a.length] = vector(v);
		return a;
	}
	if (templateName && data.func.args.got_arg[templateName]){
		return data.func.args[templateName];
	}
	if (configName && Script.config[configName]!=undefined){
		switch(typeof(Script.config[configName])){
			case "string":
				if(Script.config[configName]!=="")
					return Script.config[configName];
				break;
			case "boolean":
				return Script.config[configName];
			case "object":
				//test for DO specific vector, convert 2 array
				if (Script.config[configName].capacity != undefined)
					return VectorToArray(Script.config[configName]);
				return Script.config[configName];
		}
	}
	return defaultValue;
}
///////////////////////////////////////////////////////////////////////////////
function Debug(text) {
	try{ if(Script);
		if (0 || Script.config.DebugOutput) DOpus.Output(text);
	} catch(e){
		DOpus.Output(text);
	}
}
///////////////////////////////////////////////////////////////////////////////
function OnAboutScript(data){ //v0.1
	var cmd = DOpus.Create.Command();
	if (!cmd.Commandlist('s').exists("ScriptWizard")){
		if (DOpus.Dlg.Request("The 'ScriptWizard' add-in has not been found.\n\n"+
"Install 'ScriptWizard' from [resource.dopus.com].\nThe add-in enables this dialog and also offers "+
"easy updating of scripts and many more.","Yes, take me there!|Cancel", "No About.. ", data.window))
		cmd.RunCommand('http://resource.dopus.com/viewtopic.php?f=35&t=23179');}
	else
		cmd.RunCommand('ScriptWizard ABOUT WIN='+data.window+' FILE="'+Script.File+'"');
}
//MD5 = "2ab50905591f8a404fab79984a3fe0db"; DATE = "2015.04.19 - 15:19:52"