WebSVN – userdetect2 – Diff – /trunk/UserDetect2/UD2_Obj.pas

 {$IF CompilerVersion >= 25.0}
 {$LEGACYIFEND ON}
 {$IFEND}
+{$INCLUDE 'UserDetect2.inc'}
 uses
-  Windows, SysUtils, Classes, IniFiles, Contnrs, Dialogs;
+  Windows, SysUtils, Classes, IniFiles, Contnrs, Dialogs, UD2_PluginIntf;
 const
   cchBufferSize = 32768;
 type
     PluginGUID: TGUID;
     PluginName: WideString;
     PluginVendor: WideString;
     PluginVersion: WideString;
     IdentificationMethodName: WideString;
+    // ONLY contains the non-failure status code of IdentificationStringW
+    IdentificationProcedureStatusCode: UD2_STATUS;
+    IdentificationProcedureStatusCodeDescribed: WideString;
     Time: Cardinal;
     function PluginGUIDString: string;
     property DetectedIdentifications: TObjectList{<TUD2IdentificationEntry>}
       read FDetectedIdentifications;
     destructor Destroy; override;
     constructor Create(AIdentificationString: WideString; APlugin: TUD2Plugin);
   end;
   TUD2 = class(TObject)
   private
+    {$IFDEF CHECK_FOR_SAME_PLUGIN_GUID}
     FGUIDLookup: TStrings;
+    {$ENDIF}
   protected
     FLoadedPlugins: TObjectList{<TUD2Plugin>};
     FIniFile: TMemIniFile;
     FErrors: TStrings;
     FIniFileName: string;
     function ReadMetatagString(ShortTaskName, MetatagName: string;
       DefaultVal: string): string;
     function ReadMetatagBool(ShortTaskName, MetatagName: string;
       DefaultVal: string): boolean;
     function GetTaskName(AShortTaskName: string): string;
+    class function GenericErrorLookup(dwStatus: UD2_STATUS): string;
   end;
 implementation
 uses
-  UD2_PluginIntf, UD2_Utils;
+  UD2_Utils;
 type
   TUD2PluginLoader = class(TThread)
   protected
     dllFile: string;
     lngID: LANGID;
     procedure Execute; override;
-    procedure HandleDLL;
+    function HandleDLL: boolean;
   public
     pl: TUD2Plugin;
     Errors: TStringList;
     constructor Create(Suspended: boolean; DLL: string; alngid: LANGID);
     destructor Destroy; override;
   end;
-function UD2_ErrorLookup(dwStatus: UD2_STATUS): string;
+class function TUD2.GenericErrorLookup(dwStatus: UD2_STATUS): string;
 resourcestring
   LNG_STATUS_OK_UNSPECIFIED            = 'Unspecified generic success';
   LNG_STATUS_OK_SINGLELINE             = 'Operation successful; one identifier returned';
   LNG_STATUS_OK_MULTILINE              = 'Operation successful; multiple identifiers returned';
 procedure TUD2.HandlePluginDir(APluginDir: string);
 Var
   SR: TSearchRec;
   path: string;
-  x: TUD2PluginLoader;
+  pluginLoader: TUD2PluginLoader;
   tob: TObjectList;
   i: integer;
+  {$IFDEF CHECK_FOR_SAME_PLUGIN_GUID}
-  sPluginID, v: string;
+  sPluginID, prevDLL: string;
+  {$ENDIF}
   lngid: LANGID;
 resourcestring
   LNG_PLUGINS_SAME_GUID = 'Attention: The plugin "%s" and the plugin "%s" have the same identification GUID. The latter will not be loaded.';
 begin
   tob := TObjectList.Create;
       end;
     end;
     for i := 0 to tob.count-1 do
     begin
-      x := tob.items[i] as TUD2PluginLoader;
+      pluginLoader := tob.items[i] as TUD2PluginLoader;
-      x.WaitFor;
+      pluginLoader.WaitFor;
-      Errors.AddStrings(x.Errors);
+      Errors.AddStrings(pluginLoader.Errors);
+      {$IFDEF CHECK_FOR_SAME_PLUGIN_GUID}
-      if Assigned(x.pl) then
+      if Assigned(pluginLoader.pl) then
       begin
-        sPluginID := GUIDToString(x.pl.PluginGUID);
+        sPluginID := GUIDToString(pluginLoader.pl.PluginGUID);
-        v := FGUIDLookup.Values[sPluginID];
+        prevDLL := FGUIDLookup.Values[sPluginID];
-        if (v <> '') and (v <> x.pl.PluginDLL) then
+        if (prevDLL <> '') and (prevDLL <> pluginLoader.pl.PluginDLL) then
         begin
-          Errors.Add(Format(LNG_PLUGINS_SAME_GUID, [v, x.pl.PluginDLL]));
+          Errors.Add(Format(LNG_PLUGINS_SAME_GUID, [prevDLL, pluginLoader.pl.PluginDLL]));
-          x.pl.Free;
+          pluginLoader.pl.Free;
         end
         else
         begin
-          FGUIDLookup.Values[sPluginID] := x.pl.PluginDLL;
+          FGUIDLookup.Values[sPluginID] := pluginLoader.pl.PluginDLL;
-          LoadedPlugins.Add(x.pl);
+          LoadedPlugins.Add(pluginLoader.pl);
         end;
       end;
-      x.Free;
+      {$ENDIF}
+      pluginLoader.Free;
     end;
   finally
     tob.free;
   end;
 end;
 destructor TUD2.Destroy;
 begin
   FIniFile.Free;
   FLoadedPlugins.Free;
+  {$IFDEF CHECK_FOR_SAME_PLUGIN_GUID}
   FGUIDLookup.Free;
+  {$ENDIF}
   FErrors.Free;
 end;
 constructor TUD2.Create(AIniFileName: string);
 begin
   FIniFileName := AIniFileName;
   FLoadedPlugins := TObjectList{<TUD2Plugin>}.Create(true);
   FIniFile := TMemIniFile.Create(IniFileName);
+  {$IFDEF CHECK_FOR_SAME_PLUGIN_GUID}
   FGUIDLookup := TStringList.Create;
+  {$ENDIF}
   FErrors := TStringList.Create;
 end;
 function TUD2.GetTaskName(AShortTaskName: string): string;
 resourcestring
 begin
   Errors.Free;
   inherited;
 end;
-procedure TUD2PluginLoader.HandleDLL;
+function TUD2PluginLoader.HandleDLL: boolean;
 var
   sIdentifier: WideString;
   sIdentifiers: TArrayOfString;
   buf: array[0..cchBufferSize-1] of WideChar;
   sPluginConfigFile: string;
   iniConfig: TINIFile;
   sOverrideGUID: string;
   pluginIDfound: boolean;
   pluginInterfaceID: TGUID;
-  dllHandle: cardinal;
+  dllHandle: Cardinal;
   fPluginInterfaceID: TFuncPluginInterfaceID;
   fPluginIdentifier: TFuncPluginIdentifier;
   fPluginNameW: TFuncPluginNameW;
   fPluginVendorW: TFuncPluginVendorW;
   fPluginVersionW: TFuncPluginVersionW;
   fIdentificationMethodNameW: TFuncIdentificationMethodNameW;
   fIdentificationStringW: TFuncIdentificationStringW;
   fCheckLicense: TFuncCheckLicense;
+  fDescribeOwnStatusCodeW: TFuncDescribeOwnStatusCodeW;
   statusCode: UD2_STATUS;
   i: integer;
   starttime, endtime, time: cardinal;
+  function _ErrorLookup(statusCode: UD2_STATUS): WideString;
+  var
+    ret: BOOL;
+  begin
+    ret := fDescribeOwnStatusCodeW(@buf, cchBufferSize, statusCode, lngID);
+    if ret then
+    begin
-  loadSuccessful: boolean;
+      result := PWideChar(@buf);
+      Exit;
+    end;
+    result := TUD2.GenericErrorLookup(statusCode);
+  end;
 resourcestring
   LNG_DLL_NOT_LOADED = 'Plugin DLL "%s" could not be loaded.';
   LNG_METHOD_NOT_FOUND = 'Method "%s" not found in plugin "%s". The DLL is probably not a valid plugin DLL.';
   LNG_INVALID_PLUGIN = 'The plugin "%s" is not a valid plugin for this program version.';
   LNG_METHOD_FAILURE = 'Error "%s" at method "%s" of plugin "%s".';
 begin
-  loadSuccessful := false;
+  result := false;
   startTime := GetTickCount;
   dllHandle := LoadLibrary(PChar(dllFile));
   if dllHandle = 0 then
   begin
     begin
       Errors.Add(Format(LNG_METHOD_NOT_FOUND, [mnIdentificationMethodNameW, dllFile]));
       Exit;
     end;
+    @fDescribeOwnStatusCodeW := GetProcAddress(dllHandle, mnDescribeOwnStatusCodeW);
+    if not Assigned(fDescribeOwnStatusCodeW) then
+    begin
+      Errors.Add(Format(LNG_METHOD_NOT_FOUND, [mnDescribeOwnStatusCodeW, dllFile]));
+      Exit;
+    end;
     pl := TUD2Plugin.Create;
     pl.PluginDLL := dllFile;
     pluginIDfound := false;
     sPluginConfigFile := ChangeFileExt(dllFile, '.ini');
     end;
     statusCode := fCheckLicense(nil);
     if UD2_STATUS_Failed(statusCode) then
     begin
-      Errors.Add(Format(LNG_METHOD_FAILURE, [UD2_ErrorLookup(statusCode), mnCheckLicense, dllFile]));
+      Errors.Add(Format(LNG_METHOD_FAILURE, [_ErrorLookup(statusCode), mnCheckLicense, dllFile]));
       Exit;
     end;
     statusCode := fPluginNameW(@buf, cchBufferSize, lngID);
          if UD2_STATUS_Successful(statusCode) then pl.PluginName := PWideChar(@buf)
     else if UD2_STATUS_NotAvail(statusCode)   then pl.PluginName := ''
     else
     begin
-      Errors.Add(Format(LNG_METHOD_FAILURE, [UD2_ErrorLookup(statusCode), mnPluginNameW, dllFile]));
+      Errors.Add(Format(LNG_METHOD_FAILURE, [_ErrorLookup(statusCode), mnPluginNameW, dllFile]));
       Exit;
     end;
     statusCode := fPluginVendorW(@buf, cchBufferSize, lngID);
          if UD2_STATUS_Successful(statusCode) then pl.PluginVendor := PWideChar(@buf)
     else if UD2_STATUS_NotAvail(statusCode)   then pl.PluginVendor := ''
     else
     begin
-      Errors.Add(Format(LNG_METHOD_FAILURE, [UD2_ErrorLookup(statusCode), mnPluginVendorW, dllFile]));
+      Errors.Add(Format(LNG_METHOD_FAILURE, [_ErrorLookup(statusCode), mnPluginVendorW, dllFile]));
       Exit;
     end;
     statusCode := fPluginVersionW(@buf, cchBufferSize, lngID);
          if UD2_STATUS_Successful(statusCode) then pl.PluginVersion := PWideChar(@buf)
     else if UD2_STATUS_NotAvail(statusCode)   then pl.PluginVersion := ''
     else
     begin
-      Errors.Add(Format(LNG_METHOD_FAILURE, [UD2_ErrorLookup(statusCode), mnPluginVersionW, dllFile]));
+      Errors.Add(Format(LNG_METHOD_FAILURE, [_ErrorLookup(statusCode), mnPluginVersionW, dllFile]));
       Exit;
     end;
     statusCode := fIdentificationMethodNameW(@buf, cchBufferSize);
          if UD2_STATUS_Successful(statusCode) then pl.IdentificationMethodName := PWideChar(@buf)
     else if UD2_STATUS_NotAvail(statusCode)   then pl.IdentificationMethodName := ''
     else
     begin
-      Errors.Add(Format(LNG_METHOD_FAILURE, [UD2_ErrorLookup(statusCode), mnIdentificationMethodNameW, dllFile]));
+      Errors.Add(Format(LNG_METHOD_FAILURE, [_ErrorLookup(statusCode), mnIdentificationMethodNameW, dllFile]));
       Exit;
     end;
     statusCode := fIdentificationStringW(@buf, cchBufferSize);
+    pl.IdentificationProcedureStatusCode := statusCode;
+    pl.IdentificationProcedureStatusCodeDescribed := _ErrorLookup(statusCode);
     if UD2_STATUS_Successful(statusCode) then
     begin
       sIdentifier := PWideChar(@buf);
       if statusCode = UD2_STATUS_OK_MULTILINE then
       begin
-        // Multiple identifiers (e.g. multiple MAC addresses are delimited via #10 )
+        // Multiple identifiers (e.g. multiple MAC addresses are delimited via UD2_MULTIPLE_ITEMS_DELIMITER)
         SetLength(sIdentifiers, 0);
         sIdentifiers := SplitString(UD2_MULTIPLE_ITEMS_DELIMITER, sIdentifier);
         for i := Low(sIdentifiers) to High(sIdentifiers) do
         begin
           pl.AddIdentification(sIdentifiers[i]);
         pl.AddIdentification(sIdentifier);
       end;
     end
     else if not UD2_STATUS_NotAvail(statusCode) then
     begin
-      Errors.Add(Format(LNG_METHOD_FAILURE, [UD2_ErrorLookup(statusCode), mnIdentificationStringW, dllFile]));
+      // Errors.Add(Format(LNG_METHOD_FAILURE, [_ErrorLookup(statusCode), mnIdentificationStringW, dllFile]));
+      Errors.Add(Format(LNG_METHOD_FAILURE, [pl.IdentificationProcedureStatusCodeDescribed, mnIdentificationStringW, dllFile]));
       Exit;
     end;
     endtime := GetTickCount;
     time := endtime - starttime;
     if endtime < starttime then time := High(Cardinal) - time;
     pl.time := time;
-    loadSuccessful := true;
+    result := true;
   finally
-    if not loadSuccessful and Assigned(pl) then FreeAndNil(pl);
+    if not result and Assigned(pl) then FreeAndNil(pl);
     FreeLibrary(dllHandle);
   end;
 end;
 end.

Subversion Repositories userdetect2

userdetect2/trunk/UserDetect2/UD2_Obj.pas – Rev 69 → 70