V0.3.4.0: CreateShortcut method added

git-svn-id: https://svn.code.sf.net/p/lazarus-ccr/svn@5713 8e941d3f-bd1b-0410-a28a-d453659cc2b4
2017-01-27 11:07:34 +00:00
parent 7046b88864
commit a8ddca935f
2 changed files with 141 additions and 104 deletions
--- a/components/lazautoupdate/latest_stable/testapp/testapp.lps
+++ b/components/lazautoupdate/latest_stable/testapp/testapp.lps
@ -3,14 +3,14 @@
  <ProjectSession>
    <PathDelim Value="\"/>
    <Version Value="10"/>
-    <BuildModes Active="Win64"/>
+    <BuildModes Active="Linux32"/>
    <Units Count="28">
      <Unit0>
        <Filename Value="testapp.lpr"/>
        <IsPartOfProject Value="True"/>
        <EditorIndex Value="6"/>
        <CursorPos X="25" Y="28"/>
-        <UsageCount Value="63"/>
+        <UsageCount Value="64"/>
        <Loaded Value="True"/>
      </Unit0>
      <Unit1>
@ -21,7 +21,7 @@
        <ResourceBaseClass Value="Form"/>
        <TopLine Value="8"/>
        <CursorPos X="16" Y="15"/>
-        <UsageCount Value="63"/>
+        <UsageCount Value="64"/>
        <Loaded Value="True"/>
        <LoadedDesigner Value="True"/>
      </Unit1>
@ -32,7 +32,7 @@
        <WindowIndex Value="1"/>
        <TopLine Value="31"/>
        <CursorPos X="48" Y="14"/>
-        <UsageCount Value="46"/>
+        <UsageCount Value="47"/>
      </Unit2>
      <Unit3>
        <Filename Value="..\lazautoupdate_httpclient.pas"/>
@ -44,14 +44,14 @@
        <Filename Value="..\ulazautoupdate.pas"/>
        <IsVisibleTab Value="True"/>
        <WindowIndex Value="1"/>
-        <TopLine Value="450"/>
-        <CursorPos X="60" Y="471"/>
+        <TopLine Value="1707"/>
+        <CursorPos X="73" Y="1722"/>
        <ExtraEditorCount Value="2"/>
        <ExtraEditor1>
          <IsVisibleTab Value="True"/>
          <EditorIndex Value="1"/>
-          <TopLine Value="559"/>
-          <CursorPos Y="583"/>
+          <TopLine Value="466"/>
+          <CursorPos X="37" Y="476"/>
        </ExtraEditor1>
        <ExtraEditor2>
          <EditorIndex Value="-1"/>
@ -187,8 +187,8 @@
      <Unit22>
        <Filename Value="..\ushortcut.pas"/>
        <EditorIndex Value="4"/>
-        <TopLine Value="29"/>
-        <CursorPos X="8" Y="45"/>
+        <TopLine Value="71"/>
+        <CursorPos X="34" Y="106"/>
        <UsageCount Value="22"/>
        <Loaded Value="True"/>
      </Unit22>
@ -240,123 +240,123 @@
    <JumpHistory Count="30" HistoryIndex="29">
      <Position1>
        <Filename Value="..\ulazautoupdate.pas"/>
-        <Caret Line="1804" Column="20" TopLine="1777"/>
+        <Caret Line="242" Column="24" TopLine="214"/>
      </Position1>
      <Position2>
-        <Filename Value="..\ushortcut.pas"/>
-        <Caret Line="83" Column="34" TopLine="60"/>
+        <Filename Value="..\ulazautoupdate.pas"/>
+        <Caret Line="241" Column="34" TopLine="215"/>
      </Position2>
      <Position3>
-        <Filename Value="..\ushortcut.pas"/>
-        <Caret Line="52" Column="94" TopLine="30"/>
+        <Filename Value="..\ulazautoupdate.pas"/>
+        <Caret Line="232" Column="37" TopLine="214"/>
      </Position3>
      <Position4>
-        <Filename Value="..\ushortcut.pas"/>
-        <Caret Line="51" TopLine="10"/>
+        <Filename Value="C:\laztrunk\fpc\rtl\objpas\classes\classesh.inc"/>
+        <Caret Line="426" Column="30" TopLine="399"/>
      </Position4>
      <Position5>
-        <Filename Value="..\ushortcut.pas"/>
-        <Caret Line="91" Column="6" TopLine="64"/>
+        <Filename Value="..\ulazautoupdate.pas"/>
+        <Caret Line="232" Column="36" TopLine="214"/>
      </Position5>
      <Position6>
-        <Filename Value="..\ushortcut.pas"/>
-        <Caret Line="149" Column="31"/>
+        <Filename Value="..\ulazautoupdate.pas"/>
+        <Caret Line="281" Column="45" TopLine="259"/>
      </Position6>
      <Position7>
        <Filename Value="..\ulazautoupdate.pas"/>
-        <Caret Line="242" Column="24" TopLine="214"/>
+        <Caret Line="243" TopLine="223"/>
      </Position7>
      <Position8>
        <Filename Value="..\ulazautoupdate.pas"/>
-        <Caret Line="241" Column="34" TopLine="215"/>
+        <Caret Line="241" Column="43" TopLine="214"/>
      </Position8>
      <Position9>
        <Filename Value="..\ulazautoupdate.pas"/>
-        <Caret Line="232" Column="37" TopLine="214"/>
+        <Caret Line="251" Column="21" TopLine="223"/>
      </Position9>
      <Position10>
-        <Filename Value="C:\laztrunk\fpc\rtl\objpas\classes\classesh.inc"/>
-        <Caret Line="426" Column="30" TopLine="399"/>
+        <Filename Value="..\ulazautoupdate.pas"/>
+        <Caret Line="679" Column="49" TopLine="658"/>
      </Position10>
      <Position11>
        <Filename Value="..\ulazautoupdate.pas"/>
-        <Caret Line="232" Column="36" TopLine="214"/>
+        <Caret Line="701" Column="38" TopLine="687"/>
      </Position11>
      <Position12>
        <Filename Value="..\ulazautoupdate.pas"/>
-        <Caret Line="281" Column="45" TopLine="259"/>
+        <Caret Line="457" Column="37" TopLine="444"/>
      </Position12>
      <Position13>
        <Filename Value="..\ulazautoupdate.pas"/>
-        <Caret Line="243" TopLine="223"/>
+        <Caret Line="466" Column="23" TopLine="452"/>
      </Position13>
      <Position14>
        <Filename Value="..\ulazautoupdate.pas"/>
-        <Caret Line="241" Column="43" TopLine="214"/>
+        <Caret Line="470" Column="40" TopLine="460"/>
      </Position14>
      <Position15>
        <Filename Value="..\ulazautoupdate.pas"/>
-        <Caret Line="251" Column="21" TopLine="223"/>
+        <Caret Line="583" Column="36" TopLine="552"/>
      </Position15>
      <Position16>
        <Filename Value="..\ulazautoupdate.pas"/>
-        <Caret Line="679" Column="49" TopLine="658"/>
+        <Caret Line="553" TopLine="529"/>
      </Position16>
      <Position17>
        <Filename Value="..\ulazautoupdate.pas"/>
-        <Caret Line="701" Column="38" TopLine="687"/>
+        <Caret Line="545" Column="6" TopLine="523"/>
      </Position17>
      <Position18>
        <Filename Value="..\ulazautoupdate.pas"/>
-        <Caret Line="457" Column="37" TopLine="444"/>
+        <Caret Line="61" Column="74" TopLine="50"/>
      </Position18>
      <Position19>
        <Filename Value="..\ulazautoupdate.pas"/>
-        <Caret Line="466" Column="23" TopLine="452"/>
+        <Caret Line="570" Column="28" TopLine="542"/>
      </Position19>
      <Position20>
        <Filename Value="..\ulazautoupdate.pas"/>
-        <Caret Line="470" Column="40" TopLine="460"/>
+        <Caret Line="621" Column="46" TopLine="582"/>
      </Position20>
      <Position21>
        <Filename Value="..\ulazautoupdate.pas"/>
-        <Caret Line="583" Column="36" TopLine="552"/>
+        <Caret Line="629" Column="65" TopLine="593"/>
      </Position21>
      <Position22>
        <Filename Value="..\ulazautoupdate.pas"/>
-        <Caret Line="553" TopLine="529"/>
+        <Caret Line="637" Column="51" TopLine="615"/>
      </Position22>
      <Position23>
        <Filename Value="..\ulazautoupdate.pas"/>
-        <Caret Line="545" Column="6" TopLine="523"/>
+        <Caret Line="639" Column="8" TopLine="615"/>
      </Position23>
      <Position24>
        <Filename Value="..\ulazautoupdate.pas"/>
-        <Caret Line="61" Column="74" TopLine="50"/>
+        <Caret Line="637" Column="50" TopLine="616"/>
      </Position24>
      <Position25>
        <Filename Value="..\ulazautoupdate.pas"/>
-        <Caret Line="570" Column="28" TopLine="542"/>
+        <Caret Line="971" Column="61" TopLine="944"/>
      </Position25>
      <Position26>
        <Filename Value="..\ulazautoupdate.pas"/>
-        <Caret Line="621" Column="46" TopLine="582"/>
+        <Caret Line="480" Column="20" TopLine="448"/>
      </Position26>
      <Position27>
        <Filename Value="..\ulazautoupdate.pas"/>
-        <Caret Line="629" Column="65" TopLine="593"/>
+        <Caret Line="785" TopLine="758"/>
      </Position27>
      <Position28>
        <Filename Value="..\ulazautoupdate.pas"/>
-        <Caret Line="637" Column="51" TopLine="615"/>
+        <Caret Line="784" Column="41" TopLine="757"/>
      </Position28>
      <Position29>
        <Filename Value="..\ulazautoupdate.pas"/>
-        <Caret Line="639" Column="8" TopLine="615"/>
+        <Caret Line="474" TopLine="456"/>
      </Position29>
      <Position30>
        <Filename Value="..\ulazautoupdate.pas"/>
-        <Caret Line="637" Column="50" TopLine="616"/>
+        <Caret Line="966" Column="70" TopLine="931"/>
      </Position30>
    </JumpHistory>
  </ProjectSession>
--- a/components/lazautoupdate/latest_stable/ulazautoupdate.pas
+++ b/components/lazautoupdate/latest_stable/ulazautoupdate.pas
@ -58,11 +58,11 @@ interface


 uses
-  Forms, Classes, SysUtils, lazautoupdate_httpclient, strutils,PropEdits,
+  Forms, Classes, SysUtils, lazautoupdate_httpclient, strutils, PropEdits,
  LazUTF8, FileUtil, LazFileUtils, Dialogs, StdCtrls,
  Buttons, DateUtils,{$IFDEF LINUX}process, asyncprocess,{$ENDIF}zipper, LResources,
  VersionSupport, inifiles, aboutlazautoupdateunit, uappisrunning, LCLProc,
-  fileinfo, open_ssl, ushortcut,winpeimagereader {need this for reading exe info}
+  fileinfo, open_ssl, ushortcut, winpeimagereader {need this for reading exe info}
  , elfreader {needed for reading ELF executables}
  , machoreader {needed for reading MACH-O executables}
  {$IFDEF WINDOWS}, Windows, ShellAPI{$ENDIF}; // Thanks to Windows 10 and 704 error
@ -284,7 +284,7 @@ type
    fShowDialogs: boolean;
    fDownloadInprogress: boolean;
    fWindowsAdminCheck: boolean;
-    fShortCutClass:TShortCutClass;
+    fShortCutClass: TShortCutClass;
    {$IFDEF UNIX}
    FUpdateHMProcess: TAsyncProcess;
    {$ENDIF}
@ -354,6 +354,9 @@ type
    function CreateLocalLauImportFile: boolean;
    // If lauimport.ini is found in the app folder, move it to the AppData folder
    procedure RelocateLauImportFile;
+    // Uses properties in TShortCutClass
+    function MakeShortCut: boolean;
+
    // Download lists (now superceded by CopyTree)
    // TODO: Use Indexed properties to handle list access
    function AddToUpdateList(APrettyName, APath, AVersionString: string;
@ -450,36 +453,38 @@ type
    // Default=master but any branchname or tagname is OK
    property GitHubBranchOrTag: string read fGitHubBranchOrTag write fGitHubBranchOrTag;

-    property ShortCut:TShortCutClass read fShortCutClass write fShortCutClass;
+    property ShortCut: TShortCutClass read fShortCutClass write fShortCutClass;
  end;

-Type
-  TShortCutCategory = (scAudioVideo,scAudio,scDevelopment,
-  scEducation,scGame,scGraphics,scNetwork,scOffice,scScience,scSettings,
-  scSystem,scUtility);
-  // TShortCutCategoryFlags = Set of TShortCutCategory;
+type
+  TShortCutCategory = (scAudioVideo, scAudio, scDevelopment,
+    scEducation, scGame, scGraphics, scNetwork, scOffice, scScience, scSettings,
+    scSystem, scUtility);
+// TShortCutCategoryFlags = Set of TShortCutCategory;

-Type
-  TShortCutClass = Class(TPersistent)
+type
+  TShortCutClass = class(TPersistent)
  private
    // ShortCut stuff for CreateDesktopShortCut in ushortcut.pas
-    fShortCutTarget:String;
-    fShortCutTargetArguments:String;
-    fShortCutShortcutName:String;
-    fShortCutIconFileName:String;
-    fShortCutCategoryString:String;
-
-    fShortCutCategory:TShortCutCategory; // For easier property access
-    procedure SetShortCutCategoryString(ACategory:TShortCutCategory);
-  Public
+    fShortCutTarget: string;
+    fShortCutTargetArguments: string;
+    fShortCutShortcutName: string;
+    fShortCutIconFileName: string;
+    fShortCutCategory: TShortCutCategory; // For easier property access
+    procedure SetShortCutCategoryString(ACategory: TShortCutCategory);
+  public
+    fShortCutCategoryString: string;
    constructor Create; // Constructor must be public
    destructor Destroy; override; // Destructor must be public
+    property CategoryString: string read fShortCutCategoryString;
  published
-    property Target:String read fShortCutTarget write fShortCutTarget;
-    property TargetArguments:String read fShortCutTargetArguments write fShortCutTargetArguments;
-    property ShortcutName:String read fShortCutShortcutName write fShortCutShortcutName;
-    property IconFileName:String read fShortCutIconFileName write fShortCutIconFileName;
-    property Category:TShortCutCategory read fShortCutCategory write SetShortCutCategoryString;
+    property Target: string read fShortCutTarget write fShortCutTarget;
+    property TargetArguments: string read fShortCutTargetArguments
+      write fShortCutTargetArguments;
+    property ShortcutName: string read fShortCutShortcutName write fShortCutShortcutName;
+    property IconFileName: string read fShortCutIconFileName write fShortCutIconFileName;
+    property Category: TShortCutCategory read fShortCutCategory
+      write SetShortCutCategoryString;
  end;

  {TThreadedDownload }
@ -545,15 +550,16 @@ Type
    procedure ShowProgress;
    }
  end;
-Type
+
+type
  // For the TShortCutClass filename properties (needs propedits unit)
  TMyFileNamePropertyEditor = class(TFileNamePropertyEditor)
-    public
-      // Override the Edit method for total control
-      function GetFilter: string; override;
-      function GetDialogOptions: TOpenOptions; override;
-      function GetDialogTitle: string; override;
-    end;
+  public
+    // Override the Edit method for total control
+    function GetFilter: string; override;
+    function GetDialogOptions: TOpenOptions; override;
+    function GetDialogTitle: string; override;
+  end;


 // Non-threaded function
@ -569,9 +575,9 @@ begin
  {$I lazautoupdate_icon.lrs}
  RegisterComponents('System', [TLazAutoUpdate]);
  // Register the custom property editors for the TShortCutClass filename properties
-  RegisterPropertyEditor(TypeInfo(String),
-      TShortCutClass, 'Target', TMyFileNamePropertyEditor);
-  RegisterPropertyEditor(TypeInfo(String),
+  RegisterPropertyEditor(TypeInfo(string),
+    TShortCutClass, 'Target', TMyFileNamePropertyEditor);
+  RegisterPropertyEditor(TypeInfo(string),
    TShortCutClass, 'IconFileName', TMyFileNamePropertyEditor);
 end;

@ -579,12 +585,12 @@ end;
 function TMyFileNamePropertyEditor.GetFilter: string;
 begin
  {$IFDEF WINDOWS}
-     Result := 'Windows executable|*.exe|All Files|*.*';
+  Result := 'Windows executable|*.exe|All Files|*.*';
  {$ELSE}
    {$IFDEF LINUX}
-       Result := 'Linux executable|*.|All Files|*.*';
+  Result := 'Linux executable|*.|All Files|*.*';
    {$ELSE}
-       Result := 'All Files|*.*';
+  Result := 'All Files|*.*';
    {$ENDIF}
  {$ENDIF}
 end;
@ -616,29 +622,30 @@ begin
  while MilliSecondOfTheDay(Now) < (ThisSecond + MillisecondDelay) do ;
 end;

-procedure TShortCutClass.SetShortCutCategoryString(ACategory:TShortCutCategory);
+procedure TShortCutClass.SetShortCutCategoryString(ACategory: TShortCutCategory);
 {
 TShortCutCategory = (scAudioVideo,scAudio,scDevelopment,
 scEducation,scGame,scGraphics,scNetwork,scOffice,scScience,scSettings,
 scSystem,scUtility);
 }
 begin
-  If ACategory=fShortCutCategory then exit;
+  if ACategory = fShortCutCategory then
+    exit;

-  fShortCutCategoryString:='Unknown';
-  Case ACategory of
-     scAudioVideo:fShortCutCategoryString:='AudioVideo';
-     scAudio:fShortCutCategoryString:='Audio';
-     scDevelopment:fShortCutCategoryString:='Development';
-     scEducation:fShortCutCategoryString:='Education';
-     scGame:fShortCutCategoryString:='Game';
-     scGraphics:fShortCutCategoryString:='Graphics';
-     scNetwork:fShortCutCategoryString:='Network';
-     scOffice:fShortCutCategoryString:='Office';
-     scScience:fShortCutCategoryString:='Science';
-     scSettings:fShortCutCategoryString:='Settings';
-     scSystem:fShortCutCategoryString:='System';
-     scUtility:fShortCutCategoryString:='Utility';
+  fShortCutCategoryString := 'Unknown';
+  case ACategory of
+    scAudioVideo: fShortCutCategoryString := 'AudioVideo';
+    scAudio: fShortCutCategoryString := 'Audio';
+    scDevelopment: fShortCutCategoryString := 'Development';
+    scEducation: fShortCutCategoryString := 'Education';
+    scGame: fShortCutCategoryString := 'Game';
+    scGraphics: fShortCutCategoryString := 'Graphics';
+    scNetwork: fShortCutCategoryString := 'Network';
+    scOffice: fShortCutCategoryString := 'Office';
+    scScience: fShortCutCategoryString := 'Science';
+    scSettings: fShortCutCategoryString := 'Settings';
+    scSystem: fShortCutCategoryString := 'System';
+    scUtility: fShortCutCategoryString := 'Utility';
  end;
 end;

@ -774,10 +781,11 @@ begin
  // Freed in Destroy
  fThreadDownload := TThreadedDownload.Create();

-  fShortCutClass:=TShortCutClass.Create();
-  fShortCutClass.ShortcutName:='MyShortcutName';
-  fShortCutClass.TargetArguments:='';
-  fShortCutClass.Category:=scDevelopment;
+  fShortCutClass := TShortCutClass.Create();
+  fShortCutClass.ShortcutName := 'MyShortcutName';
+  fShortCutClass.TargetArguments := '';
+  fShortCutClass.Category := scDevelopment;
+  fShortCutClass.fShortCutCategoryString := 'Development';
  // Leave URL and Filename to be set via properties
  fComponentVersion := C_TLazAutoUpdateComponentVersion;
  // Unused
@ -959,6 +967,35 @@ begin
  end;
 end;

+function TLazAutoUpdate.MakeShortCut: boolean;
+begin
+  Result := False; // assume failure, look for success
+  if Assigned(fOndebugEvent) then
+    fFireDebugEvent := True;
+
+  if fFireDebugEvent then
+    fOndebugEvent(Self, 'MakeShortCut', 'MakeShortCut called');
+
+  if fShortCutClass.Target = '' then
+    fShortCutClass.Target := fAppFilename;
+
+  if fFireDebugEvent then
+    fOndebugEvent(Self, 'MakeShortCut', Format('Target=%s, TargetArguments=%s',
+      [fShortCutClass.Target, fShortCutClass.TargetArguments]));
+
+  if fFireDebugEvent then
+    fOndebugEvent(Self, 'MakeShortCut',
+      Format('Shortcut Name=%s, IconFileName=%s',
+      [fShortCutClass.ShortcutName, fShortCutClass.IconFileName]));
+  {$IFDEF LINUX}
+  if fFireDebugEvent then
+    fOndebugEvent(Self, 'MakeShortCut', Format('Category=%s',
+      [fShortCutClass.CategoryString]));
+  {$ENDIF}
+  Result := CreateDesktopShortCut(fShortCutClass.Target,
+    fShortCutClass.TargetArguments, fShortCutClass.ShortcutName,
+    fShortCutClass.IconFileName, fShortCutClass.CategoryString);
+end;

 procedure TLazAutoUpdate.ShowWhatsNewIfAvailable;
 begin