www.mirc.org — Viewing Code Snippet → $fileinfo & $findfileinfo

;
; Author: FiberOPtics -- mirc.fiberoptics@gmail.com
;
; Usage: $fileinfo(filepath, properties [,separator])[.raw]
;
; Purpose: Returns up to 37 characteristics of any file. For example version information
; of .exe files, audio information of .wma/.mp3 files, etc. This uses Windows
; to retrieve the properties, which are the same when you right click a column label
; in Windows Explorer to specify which attributes from a file you want to see as default.
;
;
; Properties: Audio/video: Title Artist Author AlbumTitle Year TrackNumber Genre Duration
; BitRate Audiosamplesize Audiosamplerate Channels Protected Copyright
; EpisodeName Comments
; Pictures: CameraModel DatePictureTaken Dimensions
; Executables: ProgramDescription Company Description FileVersion ProductName ProductVersion
; Misc: Attributes Status Owner Subject Category Pages
; Common: Name Size Type DateModified DateCreated DateAccessed
;
;
; Extras: * $findfileinfo(initialize, <properties> [, seperator])[.raw]
; $findfileinfo(<filepath>)
; $findfileinfo(quit)
;
; Findfileinfo is specifically designed to be used when you want to retrieve properties
; about files from a large collection. For example if you want to retrieve audio properties
; from your audio folder, which may contain hundreds or thousands of files, then $findfileinfo
; will be better suited than fileinfo.
;
; You first initialize findfileinfo by specifying as first parameter the word "initialize"
; and as second parameter the properties that you will retrieve from each file in the collection.
; Once you are done with retrieving the info, you can use "initialize" again to set new properties
; or you can quit by specifying the keyword "quit". Let's illustrate with an example:
;
; $findfileinfo(initialize, Artist Title Genre Duration Bitrate Audiosamplerate)
; !.echo -q $findfile(d:\my audio\,*,0,aline @info $findfileinfo($1-))
; $findfileinfo(quit)
;
;
; * /listtags
;
; - This alias will list all available properties that you can use on your system.
; - These properties will be in the language of your OS, but you must always use the
; English properties listed above.
;
;
; Info: - Empty values for categories are filled with a zero.
;
; - If you specify a third parameter, this will be used as a separator between
; the attributes. The default is a line feed $lf, which you can parse with
; $gettok(...,N,10) or //tokenize 10 $fileinfo(...)
;
; - There are two ways of outputting the result.
;
; (1) Default : "Propertyname: value<separator> ..."
; (2) Raw : "value<seperator> ..."
;
; The .raw property was added to give scripters more freedom in deciding the format of output.
;
;
; Installment: The snippets go into the remote section because of their alias prefix.
; Alt+r -> tab "Remote" -> Paste there.
; You can also put it in the aliases section, provided you remove the alias prefix.
;
; Requirements: $fileinfo and $findfileinfo: mIRC 5.91, Windows ME or higher
; /listtags: mIRC 6.14, all OS'es
;
; Notes: - The info on executables is only available on XP+SP2. As for the rest, most of them
; should be available on the OS'es specified in the requirements.
;
; - Improperly tagged files, will obviously return improper info. Meaning if e.g. the
; albumtitle attribute wasn't filled in the audiofile, then the snippet will not be able to
; retrieve it evidently.
;
; - After the code for the three aliases ($fileinfo, $findfileinfo, listtags) you will
; find the same aliases but now with extensive commenting, for anyone interested in
; seeing how the code works, and to get a better grasp on how to deal with COM and
; VBscript from within mIRC. I've also added small explanations here and there for
; certain coding techniques throughout the code.
;
; Examples: $fileinfo(d:\audio\song.wma,Artist Title Genre Duration Bitrate Audiosamplerate,**)
; $fileinfo($mircexe,Company Productname Productversion Fileversion Type Name)
; $fileinfo(c:\pics\mypic.jpg,Dimensions Datepicturetaken,-=-).raw
;
alias fileinfo {
var %r = return $+($chr(3),$color(info),$,fileinfo:), %result
if (!$isid) %r
if ($version < 5.91) %r This snippet requires atleast mIRC 5.91.
if ($os isin 9598) %r This snippet can only work on Windows ME or higher.
if (* !iswm $2) %r You didn't specify a property to retrieve.
if (!$isfile($1)) %r File doesn't exist: $1
var %mss = mss $+ $ticks, %t, %n = $crlf, %list, %sep = $iif($len($3)," $+ $3",vblf), %file = $1
var %props = $&
Name Size Type DateModified DateCreated DateAccessed Attributes Status Owner Author Title $&
Subject Category Pages Comments Copyright Artist AlbumTitle Year TrackNumber Genre Duration $&
BitRate Protected CameraModel DatePictureTaken Dimensions . . EpisodeName ProgramDescription . $&
Audiosamplesize Audiosamplerate Channels Company Description FileVersion ProductName ProductVersion
tokenize 32 $2
while ($0) {
if ($1 != .) && ($findtok(%props,$1,1,32)) %list = $addtok(%list,$+(",$1 $calc($ifmatch -1),"),44)
tokenize 32 $2-
}
if (!%list) %r You didn't supply any valid properties.
.comopen %mss MSScriptControl.ScriptControl
if ($comerr) %r Error opening ScriptControl object.
%t = $com(%mss,language,4,bstr*,vbscript)
%t = $&
dim list, tmp, prop, res %n $&
list = array( %list ) %n $&
set shell = createobject("shell.application") %n $&
set folder = shell.namespace( $+(",$iif($nofile(%file) != $null,$ifmatch,$mircdir),") ) %n $&
set item = folder.parsename( $+(",$nopath(%file),") ) %n $&
for each param in list %n $&
tmp = split(param," ") %n $&
prop = folder.getdetailsof(item,tmp(1)) %n $&
if len(prop) = 0 then prop = 0 %n $&
$iif($prop != raw,prop = tmp(0) & ": " & prop) %n $&
res = res & prop & %sep %n $&
next %n $&
set item = nothing : set folder = nothing : set shell = nothing %n $&
res = left(res,len(res)-len( %sep ))
if ($com(%mss,executestatement,1,bstr*,%t)) && ($com(%mss,eval,3,bstr*,res)) {
%result = $com(%mss).result
}
else %result = Error executing VBScript to retrieve fileinfo.
:error
if ($com(%mss)) .comclose %mss $com(%mss,reset,1)
return %result
}
;
; Use this alias if you want to use fileinfo on a large collection of files at once when
; used with $findfile on an entire folder and subfolders
;
; First initialize with: $findfileinfo(initialize, <properties>)
; Call it with: $findfileinfo(<filepath>)
; Free resources with: $findfileinfo(quit)
;
alias findfileinfo {
if (!$isid) return
var %t, %obj = findfileinfo
if ($1 == initialize) {
var %r = return $+($chr(3),$color(info),$,%obj:)
if ($version < 5.91) %r This snippet requires atleast mIRC 5.91.
if ($os isin 9598) %r This snippet can only work on Windows ME or higher.
if (* !iswm $2) %r you must specify properties to retrieve.
if ($com(%obj)) .comclose %obj
.comopen %obj MSScriptControl.ScriptControl
var %sep = $iif($len($3)," $+ $3",vblf), %n = $crlf, %list
var %props = $&
Name Size Type DateModified DateCreated DateAccessed Attributes Status Owner Author Title $&
Subject Category Pages Comments Copyright Artist AlbumTitle Year TrackNumber Genre Duration $&
BitRate Protected CameraModel DatePictureTaken Dimensions . . EpisodeName ProgramDescription . $&
Audiosamplesize Audiosamplerate Channels Company Description FileVersion ProductName ProductVersion
tokenize 32 $2
while ($0) {
if ($1 != .) && ($findtok(%props,$1,1,32)) %list = $addtok(%list,$+(",$1 $calc($ifmatch -1),"),44)
tokenize 32 $2-
}
if (!%list) %r you didn't specify any valid properties.
%t = $com(%obj,language,4,bstr*,vbscript)
%t = $&
Function FindFileInfo(dir,file) %n $&
list = array( %list ) %n $&
set shell = createobject("shell.application") %n $&
set folder = shell.namespace(dir) %n $&
set item = folder.parsename(file) %n $&
for each param in list %n $&
tmp = split(param," ") %n $&
prop = folder.getdetailsof(item,tmp(1)) %n $&
if len(prop) = 0 then prop = 0 %n $&
$iif($prop != raw,prop = tmp(0) & ": " & prop) %n $&
%obj = %obj & prop & %sep %n $&
next %n $&
set item = nothing : set folder = nothing : set shell = nothing %n $&
%obj = left( %obj ,len( %obj )-len( %sep )) %n $&
End Function
%t = $com(%obj,addcode,1,bstr*,%t)
return $iif(%t == 1,$true,$false)
}
elseif ($1 == quit) && ($com(%obj)) .comclose %obj $com(%obj,reset,1)
else {
if (!$com(%obj)) || (!$isfile($1)) return
%t = FindFileInfo( $+(",$nofile($1),",$chr(44),",$nopath($1),") )
%t = $com(%obj,eval,3,bstr*,%t)
return $com(%obj).result
}
}
alias listtags {
var %e = !echo -ac info * /listtags:
if ($version < 6.14) { %e this alias requires atleast mIRC 6.14 | return }
var %objShell = objshell $+ $ticks, %objFolder = objfolder $+ $ticks, %i = 0, %t
.comopen %objShell shell.application
if ($comerr) { %e error opening Shell.Application object | return }
%t = $com(%objShell,namespace,1,bstr,$mircdir,dispatch* %objFolder)
if ($com(%objFolder)) {
!echo -ac info * Listing available properties on your system...
while (%i < 40) {
%t = $com(%objFolder,getdetailsof,1,bstr*,null,uint,%i)
!echo -a Index %i - $com(%objFolder).result
inc %i
}
.comclose %objFolder
}
.comclose %objShell
}
; This is the end of the uncommented code. What follows are the same aliases,
; but with extensive comments for those interested in knowing a bit better
; how exactly the code works the way it does.
alias fileinfo {
var %r = return $+($chr(3),$color(info),$,fileinfo:), %result
; Basic error checking, the reason is explained in the error message that is returned.
if (!$isid) %r
if ($version < 5.91) %r This snippet requires atleast mIRC 5.91.
if ($os isin 9598) %r This snippet can only work on Windows ME or higher.
if (!$isfile($1)) %r File doesn't exist: $1
if (* !iswm $2) %r You didn't specify a property to retrieve.
; Setting some variables, taking advantage of /var's ability to assign multiple variables on a single line.
; The variable %mss will be used as the name of our main COM objet. We use the identifier $ticks in it
; to make sure that the name is unique, and thus doesn't collide with another object with the same name.
var %mss = mss $+ $ticks, %t, %n = $crlf, %list, %sep = $iif($len($3)," $+ $3",vblf), %file = $1
; We put the properties in a variable and we will later on use the position of the property
; as an index that we need to pass to a COM object. The reason for the dots here and there,
; is so that the properties would maintain their correct position, because Windows apparently
; skipped a few numbers in their indexes for whatever reason. You can actually see this when
; using the /listtags alias, which will show there are some gaps. $& is an identifier in mIRC
; which allows you to split code on multiple lines. When mIRC evaluates it though, it puts back
; all strings on one line, so the variable %props is one long line of properties.
var %props = $&
Name Size Type DateModified DateCreated DateAccessed Attributes Status Owner Author Title $&
Subject Category Pages Comments Copyright Artist AlbumTitle Year TrackNumber Genre Duration $&
BitRate Protected CameraModel DatePictureTaken Dimensions . . EpisodeName ProgramDescription . $&
Audiosamplesize Audiosamplerate Channels Company Description FileVersion ProductName ProductVersion
; Tokenizing parameter $2 from the identifier, which holds the list of properties for which you
; want to retrieve info. The looping is done using a while loop with the condition ($0), which
; will keep looping until there are no more tokens left.
tokenize 32 $2
while ($0) {
; If we find the specified property in the list of properties %props,
; then add the name of the property ($1) as well as its index ($ifmatch - 1) to a
; comma seperated variable %list which will look like: "name 0","size 1","type 2" etc.
; The if check for $1 not being a dot is necessary, because there are dots in the variable
; %props used to maintain the correct position of certain properties, however obviously
; we don't want them included in our list.
if ($1 != .) && ($findtok(%props,$1,1,32)) %list = $addtok(%list,$+(",$1 $calc($ifmatch -1),"),44)
; Tokenize all other tokens except the first one so that the second token in the list
; now becomes the first token $1
tokenize 32 $2-
}
if (!%list) %r You didn't supply any valid properties.
; Open the MSScriptControl.ScriptControl object which is a script interpreter, able to
; interpret both VBscript or Jscript, thus giving us the functionality of those languages from
; within mIRC. The name of the object is assigned to the value of variable %mss.
.comopen %mss MSScriptControl.ScriptControl
; If there was an error opening the object, then we must stop the alias.
if ($comerr) %r Error opening ScriptControl object.
; Set the language of the script interpreter to vbscript. Setting a property requires number 4
; as third parameter in a $com call, and what we are passing is a basic string (bstr) by reference (*)
%t = $com(%mss,language,4,bstr*,vbscript)
; We now populate the variable %t with the code that will do the actual retrieving of the info.
; This code is in Visualbasicscript, and each line of code is seperated by a $crlf, which is a
; combination of a carriage return ($cr) and a line feed ($lf).
; We use the $& identifier in mIRC to be able to put our code on multiple lines, but when mIRC
; will interpret it, it will put all the lines on one single line and treat them as such.
; I cannot comment in between this lines because of the $& identifier, so I will write a summary
; of it here instead.
; dim list, tmp, prop, res
; --> initializing of variables like you would do with /var
; list = array( %list )
; -> create an array "list" that will hold our properties from the variable %list. We cannot put
; array(%list) because mIRC wouldn't be able to evaluate the %list identifier. mIRC doesn't
; understand VBScript, so as far as it is concerned it just sees a basic string with no
; meaning in mIRC Scripting.
; set shell = createobject("shell.application")
; -> create the main object that will retrieve the info
; set folder = shell.namespace( $+(",$iif($nofile(%file) != $null,$ifmatch,$mircdir),") )
; -> retrieve a reference to the folder where the file resides of which we want to find the info.
; We call this object "folder". $nofile(<path>) returns the path of a file without the filename.
; If the file didn't have a path, then it means it's a file from our main mIRC folder.
; The reason I use $nofile($1) != $null and not just $iif($nofile($1), ..., ...) is because
; a folder can be the digit "0", which would evaluate to $false in the if check. Other ways
; would be to use $len($nofile($1)) or * iswm, to see if $nofile($1) evaluates to
; something, but I choose for the != $null check so that $ifmatch can be used.
; set item = folder.parsename( $+(",$nopath(%file),") )
; -> retrieve a reference to the file by using $nopath which returns the filename of a filepath
; without the folderpath. This item in other words, is a reference to the actual file of
; which we will retrieve information. Note that in both this and the above case, the " "
; are used to represent string literals in VBscript, they are not related to the " " that you
; would use around a filepath in mIRC to correctly interpret spaces.
; for each param in list
; -> initializing a for each loop, which will loop through each property that we had stored
; earlier in our array "list". the variable "param" will each time be a <name>:<index> pair.
; tmp = split(param," ")
; -> split this parameter up into the name and the index and store it in array tmp, which we can then
; access with tmp(1) being the index number, and tmp(2) being the name of the property.
; prop = folder.getdetailsof(item,tmp(1))
; -> assign the value of the property that we access with tmp(1) and store it in variable prop.
; We now have retrieved the value that we were looking for.
; if len(prop) = 0 then prop = 0
; -> if the value of the property was empty, we will replace it with a 0.
; $iif($prop != raw,prop = tmp(0) & ": " & prop)
; -> If the user specified the .raw property, we will not include the name of the property in our
; final result. If they didn't specify it, we include it by assigning tmp(0) to variable prop.
; res = res & prop & %sep
; -> we store the value of variable prop into variable res, which is what we will return to mIRC
; once we have looped through all parameters.
; next
; -> this tells VBscript to continue with the loop from the top again, thus going to the next parameter.
; set item = nothing : set folder = nothing : set shell = nothing
; -> we release resources by setting the open COM objects to nothing. Unfortunately, the Scriptcontrol
; object doesn't seem to want to perform this properly, but I added it anyway because it's more "correct".
;
; res = left(res,len(res)-len( %sep ))
; -> we are done with looping, and now have the variable res with all our information we requested
; This variable's value will now be retrieved back with regular mIRC scripting.
%t = $&
dim list, tmp, prop, res %n $&
list = array( %list ) %n $&
set shell = createobject("shell.application") %n $&
set folder = shell.namespace( $+(",$iif($nofile(%file) != $null,$ifmatch,$mircdir),") ) %n $&
set item = folder.parsename( $+(",$nopath(%file),") ) %n $&
for each param in list %n $&
tmp = split(param," ") %n $&
prop = folder.getdetailsof(item,tmp(1)) %n $&
if len(prop) = 0 then prop = 0 %n $&
$iif($prop != raw,prop = tmp(0) & ": " & prop) %n $&
res = res & prop & %sep %n $&
next %n $&
set item = nothing : set folder = nothing : set shell = nothing %n $&
res = left(res,len(res) - len( %sep ))
; The following if check does two things:
; 1) It evaluates two times a $com call, first time with method "executestatement" which will execute
; the code that we had filled our variable %t with. Therefore we pass this variable %t as an argument
; to the $com call. Secondly, it evaluates another $com call by calling the "eval" property on the COM
; object. That will make the code that we just executed evaluated, and allows us to retrieve the value
; of the VBscript variable "result". Therefore we pass this variable as a bstr* to the $com call.
; 2) It checks to see if both $com calls were successfully. If they were, they both returned "1",
; which makes the code proceed to the statement: %result = $com(%mss).result
; If they weren't successful, then it goes to the statement: %r Error executing VBScript to
; retrieve fileinfo.
; Don't confuse the .result property of $com() with our VBscript variable "result".
; They have nothing to do with each other. $com(<object>) result will always store the result
; of property call on an object in mIRC. It's simply a coincidence that I used the name "result"
; to store the properties in VBscript.
if ($com(%mss,executestatement,1,bstr*,%t)) && ($com(%mss,eval,3,bstr*,result)) {
%result = $com(%mss).result
}
else %result = Error executing VBScript to retrieve fileinfo.
; This error label will make mIRC jump to here in case any error has occured when mIRC was interpreting
; the code. In here, we close the com object if it was still open, but first resetting it to free any
; resources used in the VBScript code such as our open objects. We use this method additinoally to adding
: something like: set shell = nothing. Normally this works in VBScript, but the Script Interpreter
: doesn't perform it properly, therefore the reset method.
:error
if ($com(%mss)) .comclose %mss $com(%mss,reset,1)
; We return our result which was stored earlier in variable %result if no error has happened.
; If an error has happened, %result will just be empty, so it will return nothing. That's why
; we intialized %result at the beginning of the code. If an error would happen before %result
; is initialized as a local variable, then it would return the value of a possibly existing
; global variable %result, something we definitely don't want.
return %result
}
; Use this alias if you want to use fileinfo on a large collection of files at once when
; used with $findfile on an entire folder and subfolders
;
; First initialize with: $findfileinfo(initialize,<properties>)
; Call it with: $findfileinfo(<filepath>)
; Free resources with: $findfileinfo(quit)
;
alias findfileinfo {
; Commenting for this snippet will be less than for $fileinfo, because a lot of the code is the same.
; I will only explain the differences, and why exactly I made it different.
; If the alias was called as command instead of an identifier, then return.
if (!$isid) return
; Instead of using a unique variable like in $fileinfo, we specify as name "findfileinfo", because
; this object must remain open in your mIRC until you decide to manually close it with $findfileinfo(quit)
var %t, %obj = findfileinfo
if ($1 == initialize) {
; Very similar code as for $fileinfo until the VBscript code.
var %r = return $+($chr(3),$color(info),$,findfileinfo:)
if ($version < 5.91) %r This snippet requires atleast mIRC 5.91.
if ($os isin 9598) %r This snippet can only work on Windows ME or higher.
if (* !iswm $2) %r you must specify properties to retrieve.
if ($com(%obj)) .comclose %obj
.comopen %obj MSScriptControl.ScriptControl
var %sep = $iif($len($3)," $+ $3",vblf), %n = $crlf, %list
var %props = $&
Name Size Type DateModified DateCreated DateAccessed Attributes Status Owner Author Title $&
Subject Category Pages Comments Copyright Artist AlbumTitle Year TrackNumber Genre Duration $&
BitRate Protected CameraModel DatePictureTaken Dimensions . . EpisodeName ProgramDescription . $&
Audiosamplesize Audiosamplerate Channels Company Description FileVersion ProductName ProductVersion
tokenize 32 $2
while ($0) {
if ($1 != .) && ($findtok(%props,$1,1,32)) %list = $addtok(%list,$+(",$1 $calc($ifmatch -1),"),44)
tokenize 32 $2-
}
if (!%list) %r you didn't specify any valid properties.
%t = $com(%obj,language,4,bstr*,vbscript)
; You will notice here that unlike in $fileinfo, the VBScript starts different.
; Here I am creating a function in VBScript called "FindFileInfo" that takes two parameters,
; being a path to a folder (dir) and a file name (file). At the end of the VBscript, we finish
; the declaration of the function with the statement "End Function".
;
; You also notice that instead of initializing variable "res" I am now intializing the variable
; "findfileinfo". This variable will be used to return our result. In VBscript, when you call a
; function that is supposed to return a result, you will put the value of this result in the
; variable that has the same name as the function. For example:
;
; Function MyFunc()
; myfunc = "woot"
; End Function
; When calling The MyFunc() function, it will return the value of myfunc, being the string woot.
;
%t = $&
Function FindFileInfo(dir,file) %n $&
dim list, tmp, prop, %obj %n $&
list = array( %list ) %n $&
set shell = createobject("shell.application") %n $&
set folder = shell.namespace(dir) %n $&
set item = folder.parsename(file) %n $&
for each param in list %n $&
tmp = split(param," ") %n $&
prop = folder.getdetailsof(item,tmp(1)) %n $&
if len(prop) = 0 then prop = 0 %n $&
$iif($prop != raw,prop = tmp(0) & ": " & prop) %n $&
%obj = %obj & prop & %sep %n $&
next %n $&
set item = nothing : set folder = nothing : set shell = nothing %n $&
%obj = left( %obj ,len( %obj )-len( %sep )) %n $&
End Function
; Instead of doing "executestatement" and "eval" like in $fileinfo, all we do is add this FindFileInfo
; function to the Script interpreter without making it do anything. For this we use the "addcode" method.
; We do this because with future calls of FindFileInfo, we only then need to do a simple "eval" to get our
; required results. The main difference here is that the properties to retrieve have been hardcoded in the
; VBScript function. With each call of $findfileinfo it will retrieve the same properties, only the file
; will be different.
%t = $com(%obj,addcode,1,bstr*,%t)
; %t will store the value of our $com call. If it was successful1 (1) return $true, else return $false.
return $iif(%t == 1,$true,$false)
}
; If you specified $findfileinfo(quit) then we close the main object if it is open,
; whilst calling the reset method on it. We do this to free any resources used by the
; VBscript like the COM objects. You can see that we have the $com(%obj,reset,1) on the
; same line as the .comclose %obj code, which may look confusing, because aren't we
; closing the object first, so how could we still invoke a method on this object?
; In mIRC, when executing a command, mIRC first evaluates any parameters passed to the
; command. If it wouldn't, then if you did //echo -a $me, it would never show your real
; nickname, but rather echo $me. Instead mIRC evaluates $me to your current nickname,
; and then it echoes it. Similarly here, mIRC first evaluates the $com identifier,
; before it closes the object.
;
elseif ($1 == quit) && ($com(%obj)) .comclose %obj $com(%obj,reset,1)
else {
; If you didn't specify a valid filepath, or if the main object doesn't exist, then return.
if (!$com(%obj)) || (!$isfile($1)) return
; First assign the string FindFileinfo("<folderpath>","<filename>") to variable %t.
%t = FindFileInfo( $+(",$nofile($1),",$chr(44),",$nopath($1),") )

Projects's information