Script won't work properly with FILTERFLAGS=deselect

fred · September 12, 2016, 9:53pm

Hi,

I posted a script here. Please read the script thread to know what it does.

After some test, there is a bug returning no error: If you select only image files, it will work properly as intended. But if among the selected files there are other file types, the script won't apply metadata to the image files. And yet, the script is supposed to handle this case.

Reproduce the "bug" and comments

So select one image file + a text file as an example.

Actually, line 22

cmd.RunCommand("Select """&Filter&""" FILTER FILTERFLAGS=deselect")

works as intended, the text file is deselected.

Line 26, I check that the script registered this new state with

DOpus.Output "Number of selected files that the script will apply GPS : " & ClickData.Func.sourcetab.selected.count
It did since it only report the current number of selected images files. Only 1 in that case.

Line 98, just before applying the metadata, I check again that my variables are OK and the script still works with the selected file

DOpus.Output "Latitude = " & Lat & vbCrLf & "Longitude = " & Lon DOpus.Output "Number of selected files that the script will apply GPS : " & ClickData.Func.sourcetab.selected.count cmd.RunCommand("SetAttr META gpslatitude:"&Lat&"") cmd.RunCommand("SetAttr META gpslongitude:"&Lon&"")
And yet, the metadata won't apply while if you only select image files from the very start, it works.

I'm lost. I really need some enlightenment.

Here is an updated version of the button used as reference for above. Unlike the original button, I just added the option to directly apply the GPS data from clipboard instead of using a prompt dialog as a step to retrieve them.

<?xml version="1.0"?> <button backcol="none" <label>Bouton</label> <icon1>#newcommand</icon1> <function type="script"> <instruction> <instruction> <instruction /> <instruction>@script <instruction /> <instruction>' <instruction>' <instruction>Dim <instruction>Filter <instruction /> <instruction>Function <instruction> <instruction> <instruction /> <instruction> <instruction> <instruction> <instruction> <instruction> <instruction /> <instruction> <instruction> <instruction /> <instruction> <instruction> <instruction> <instruction> <instruction /> <instruction> ' <instruction> If <instruction> Set <instruction> dlg.Request <instruction> Exit <instruction> End <instruction /> <instruction> <instruction> <instruction> <instruction> <instruction> <instruction> <instruction> <instruction> <instruction> <instruction> <instruction> <instruction> <instruction> <instruction> <instruction> <instruction> <instruction> <instruction /> <instruction> <instruction> <instruction> <instruction /> <instruction> <instruction> <instruction> <instruction> <instruction> <instruction> <instruction> <instruction>' <instruction> <instruction> <instruction> <instruction> <instruction> <instruction /> <instruction> <instruction /> <instruction> <instruction> <instruction> <instruction> <instruction> <instruction /> <instruction> <instruction> <instruction> <instruction> <instruction>' <instruction>' <instruction> <instruction> <instruction>' <instruction> <instruction> <instruction> <instruction> <instruction> <instruction> <instruction> <instruction> <instruction /> <instruction> <instruction> <instruction> <instruction> <instruction> <instruction>End </function> </button> display="both" textcol="none"> @disablenosel</instruction> @filesonly</instruction> vbscript</instruction> Please select a filter to exclude non images files</instruction> Typacally it should be a filter that actually matches image files you want to apply coordinates to.</instruction> Filter</instruction> = "Non Image files"</instruction> OnClick(ByRef ClickData)</instruction> ' Clear the log output</instruction> DOpus.ClearOutput</instruction> ' INITIATE VARIABLES</instruction> UseDialog = False</instruction> Match = 0</instruction> Set cmd = ClickData.Func.command</instruction> Dim GpsInput</instruction> ' This will deselect all non image files</instruction> cmd.RunCommand("Select """&Filter&""" FILTER FILTERFLAGS=deselect")</instruction> ' Number of selected files to check the previous deselect command has run properly</instruction> ' And YES it is</instruction> CountSel = ClickData.Func.sourcetab.selected.count</instruction> DOpus.Output "Number of selected files that the script will apply GPS : " & CountSel</instruction> Check if at least 1 file is selected to continue else exit.</instruction> ClickData.Func.sourcetab.selected_files.count < 1 Then</instruction> dlg = ClickData.Func.Dlg</instruction> "No file selected" & vbCrLf & "Please select at least 1 and run the command again", "OK"</instruction> Function</instruction> If</instruction> ' Ask coordinates until they are valid</instruction> Do While Match = 0</instruction> ' In case prompt dialog is used</instruction> If UseDialog = True then</instruction> ' Create 1st Dialog object.</instruction> Set dlg = DOpus.Dlg</instruction> ' Initialise the object to display a message with 2 buttons and 1 input box</instruction> dlg.Window = DOpus.Listers(0)</instruction> dlg.title = "GPS coordinates"</instruction> dlg.message = "Paste the coordinates you copied from Google Maps."& vbCrLf & vbCrLf &"Ex: 47.338388, 0.990228"</instruction> dlg.buttons = "&OK|&Cancel"</instruction> dlg.icon = "question"</instruction> dlg.max = 128 ' enable the text field</instruction> ' Show the dialog and print the results to the script log</instruction> ret = dlg.Show</instruction> ' DOpus.Output "Dialog.Show returned " & ret</instruction> ' DOpus.Output "The string you entered was " & dlg.input</instruction> If ret = 0 then ' When user cancel action</instruction> Exit Function</instruction> End If</instruction> GpsInput = dlg.input</instruction> ' DOpus.Output "GpsInput : """ & GpsInput & """"</instruction> Set dlg = Nothing ' destroy 1st dialog prompt</instruction> Else</instruction> ' In case prompt dialog is not used, just read the clipboard</instruction> If DOpus.GetClipFormat = "text" Then</instruction> GpsInput = DOpus.GetClip</instruction> DOpus.Output "GpsInput : """ & GpsInput & """"</instruction> Else</instruction> Set dlg = ClickData.Func.Dlg</instruction> dlg.Request "Clipboard content is not as text format" & vbCrLf & "Be sure to copy only coordinates as text and try again", "OK"</instruction> Exit Function</instruction> End If</instruction> End if</instruction> ' Check if the input is a valid GPS coordinates</instruction> ' Create a RegExp object. See http://msdn2.microsoft.com/en-us/library/ms974570.aspx</instruction> Set re = New RegExp</instruction> re.IgnoreCase = True ' Case-sensitive matching.</instruction> re.Global = False ' All matches will be matched, not just the first match.</instruction> re.Pattern = "^(-?[1-8]?\d(?:\.\d{1,18})?|90(?:\.0{1,18})?),\s+?(-?(?:1[0-7]|[1-9])?\d(?:\.\d{1,18})?|180(?:\.0{1,18})?)$"</instruction> Set matches = re.Execute(GpsInput)</instruction> If matches.Count = 1 Then ' Case if pasted values contains valid coordinates</instruction> Match = 1</instruction> DOpus.Output "GpsInput is VALID"</instruction> DOpus.Output "Found " & matches.Count & " matches" & vbCRLF & "Match value : " & matches.Item(0).Value</instruction> Lat = matches.Item(0).SubMatches(0)</instruction> Lon = matches.Item(0).SubMatches(1)</instruction> DOpus.Output "Latitude = " & Lat & vbCrLf & "Longitude = " & Lon</instruction> Else ' Case if pasted values contains invalid coordinates</instruction> Set dlg = ClickData.Func.Dlg</instruction> dlg.Request "The format of the coordinates you pasted are wrong" & vbCrLf & "Try again", "OK"</instruction> If UseDialog = False Then Exit Function</instruction> ' Clear the log output</instruction> DOpus.ClearOutput</instruction> End If</instruction> Loop</instruction> ' Apply coordinates to files</instruction> DOpus.Output "Latitude = " & Lat & vbCrLf & "Longitude = " & Lon</instruction> DOpus.Output "Number of selected files that the script will apply GPS : " & ClickData.Func.sourcetab.selected.count</instruction> cmd.RunCommand("SetAttr META gpslatitude:"&Lat&"")</instruction> cmd.RunCommand("SetAttr META gpslongitude:"&Lon&"")</instruction> Function</instruction>

Regards

Leo · September 14, 2016, 10:24am

The Command object has methods to change which files it will act on. ClearFiles, AddFile, etc.

Generally, running the Select command in a script won't change anything, except what is selected in the file display.

Also note that you can set both pieces of metdata at once in a single update of the file, which should speed things up and may also make things more reliable, as the file isn't opened, updated and closed twice:

SetAttr META gpslatitude:x gpslongitude:y

fred · September 14, 2016, 10:48pm

Good point about the SetAttr Meta.

I will see how I can handle the file with the methods of command obj. I guess I will need to iterate through selected files and add them to the collection the script apply to.

Leo · September 14, 2016, 11:06pm

Selected files are added to the command by default, but you might want to remove the unwanted ones. (Or you can clear the list, then add the wanted ones, if it's easier.)

fred · September 16, 2016, 1:44am

Thanks. I learn a lot about scripting to handle selected file, filter them, select from script, etc.

Issue is fixed in the last version that work like a charm.

Here is a sample code to show how I handle this. You can test it in a button.

[code]@disablenosel
@filesonly

@script vbscript
' This sample script show you how you can filter selected files by their metadata type
' and handle them to do stuff you need.

Function OnClick(ByRef ClickData)

' ============================================================================
'                         INITIATE VARIABLES & OBJECT
' ============================================================================
Set cmd = ClickData.Func.command
Set srce = ClickData.Func.sourcetab

' ============================================================================
'                         FILTER FILES TO BE PROCESSED
' ============================================================================
DOpus.Output ""
DOpus.Output "============================================================================"
DOpus.Output ""
DOpus.Output "Selected files BEFORE filter : " & srce.selected_files.count
DOpus.Output "Files that will actually be processed BEFORE filter : " & cmd.files.count
cmd.ClearFiles ' All items are removed from the collection so only image files will be added next
DOpus.Output ""
DOpus.Output "FILTERING…"
DOpus.Output ""
n = 1
For Each f In srce.selected_files
    ' If a selected file can handle GPS metadata, it will be added to files to process
    If (f.metadata = "image") then
        cmd.AddFile(f)
        DOpus.Output n & ". """ & f.name & """ will be processed"
    End if
    n = n+1
Next
DOpus.Output ""
' Select files in the active tab that will actually be processed
cmd.RunCommand("Select FROMSCRIPT DESELECTNOMATCH MAKEVISIBLE")
srce.Update ' Synchronize changes made by the previous select command to the sourcetab object. It can be useful if you need to use this object later.
DOpus.Output "Selected files AFTER filter : " & srce.selected_files.count
DOpus.Output "Files that will actually be processed AFTER filter : " & cmd.files.count

' Check if at least 1 file is selected to continue else warn and exit.
If cmd.files.count < 1 Then
    Set dlg = ClickData.Func.Dlg
    dlg.Request "No file selected or no valid file to process."  & vbCrLf & "Please select at least 1 image file and run the command again", "OK"
    Set dlg = Nothing ' destroy dialog
    Exit Function
End If

' Go on with what you need to do with those files next.
' Now any cmd.RunCommand will apply to the files that are actually selected.

End Function
[/code]