DLFile - 2022/02/27

[TheArkive]

AHK v2 version is here.

DLFile is a class for downloading a file. It's meant to be a simple replacement for the DownloadFile command with the following improvements:

• Get live stats: file size, bytes downloaded, Bps, file name, percent complete, and a few more things.
• Specify a callback func to get and display the live stats.
• The ability to abort the download by setting obj.cancel := true
• File downloads as file.ext.temp, and is renamed to specified file.ext on completion.
• Optionally delete a partial download by setting obj.del_on_cancel := true before calling Obj.Start()
• Supports resume.
• Supports batch downloading.

To-Do List:

• ... thinking of what direction to take this ...

==================================================

Updates

2022/02/28

• fixed batch download logic to behave as expected

2022/02/27

• now supports batch downloading (an array of URLs)
• still supports a single download (url param is a single URL string)
• updated docs
• commented out CheckPartial() method for now

2022/02/25 - Previous AHK v2 development

• Improved example to show how to Cancel/Resume within the GUI.
• Added del_on_cancel param so this can be set on obj creation.

2022/02/17

• Resume now works (for the example) - there may be other servers/implementations that need to be addressed.
• Removed some unneeded bits of code.
• Updated usage docs.
• Added methods obj.CheckPartial(), obj.CheckLength().

==================================================

Download on GitHub

==================================================

I could use some help with testing the resume feature. I'll be trying to test this of course, but several different servers / downloads need to be tested to make sure at least the basic expected implementation has been covered.

[TheArkive]

@BoBo

This seems to work ok on V1 so far. I cheated on the UI for pause/cancel/resume but the main idea still holds up.

[haichen]

That's great. I managed to start several downloads in a row for v2. Maybe you could include processing a list or array. No matter if for v1 or v2.

[TheArkive]

@haichen

Built into the class? Or as an example?

[haichen]

My computer just crashed with a "system_service_exception".... Runs again.
Basically I don't care. You have created this great tool. I would love an example for V1. If you want to include it in the class, I would find this also wonderful.

[TheArkive]

My computer just crashed with a "system_service_exception".... Runs again.

Yikes! If you can confirm it is from this script, or at least maybe it is likely this script, please let me know. I'll try to replicate.

Basically I don't care. You have created this great tool. I would love an example for V1. If you want to include it in the class, I would find this also wonderful.

As for including the functionality, that shouldn't be a problem. I'll make it work as an array for batch input, or a string for single input.

[BoBo]

@TheArkive - Nice!
I've played a little with that (G)UI stuff, hope you don't mind

DLFileGui

Code: Select all

url:="https://dl.google.com/android/repository/commandlinetools-win-8092744_latest.zip"
dest := A_Desktop "\commandlinetools-win-8092744_latest.zip"

DL := new DLFile(url,dest,"callback")

/*
Msgbox % "F2 = Cancel`n`nF3 = Resume`n`nESC = Exit"

Progress, W500 , % " ", % " ", Download File / F2 = Cancel / F3 = Resume / ESC = Exit, Consolas
Progress, Show
*/

Gui, -Caption +Border
Gui, Add, Text,		x14		y12		w310	 		vFile	,% o.file
Gui, Add, Button, 	x10		yp+26	w100	 gSUS	   		,  Suspend
Gui, Add, Button, 	xp+102	yp		wp		 gRES			,  Resume
Gui, Add, Button, 	xp+102	yp		wp		 gESC			,  ESC
Gui, Add, Progress, x10		yp+26	w304 h24 cBlue vProg	,% o.perc
Gui, Add, Text,		xp+4	yp+32	w100 h24	   vKBps	,% "KBps:`t" 0
Gui, Add, Text,		xp+102	yp		w100 h24	   vPerc	,% "Progress:`t" 0 " %"
Gui, Show, w324 h120,% o.file
;;;; DL.del_on_cancel := true ; enable/uncommon this to delete partial files after cancel

DL.Start()

/*
callback(o:="") {
    Progress, % o.perc, % "KBps: " Round(o.bps/1024)  "   /   Progress: " o.perc "%", % o.file
}
*/

callback(o:="") {
	GuiControl,, File,% o.file
	GuiControl,, Prog,% o.perc
	GuiControl,, KBps,% "KBps: " Round(o.bps/1024)
	GuiControl,, Perc,% "Progress: " o.perc " %"
	}

SUS:
	DL.cancel := true
	Return
RES:
	DL.Start()
	Return
ESC:
ESC::
	ExitApp

.

TheArkive - DLFileGui.png (70.49 KiB) Viewed 1649 times

[TheArkive]

@BoBo

I don't mind at all

I'm about to post an update for batch downloads (built-in functionality).

EDIT: I'll add your code to the v1 script eventually (if you don't mind )

[TheArkive]

2022/02/27

• now supports batch downloading (an array of URLs)
• still supports a single download (url param is a single URL string)
• updated docs
• commented out CheckPartial() method for now

[BoBo]

@TheArkive - AFAICS, the "cancel"-Button/option is suspending (therefore I'd opt to label it 'Suspend') the download bc the progress bar is stopping, not collapsing, OTOH the "resume"-Button/option looks like restarting the DL, instead of going on where it has been suspended? If I'm wrong and 'cancel' means stopping the download I'd opt for 'Exit DL' instead of 'Cancel', bc it's hard to distinguish between 'Cancel' and 'ESC'!?

[TheArkive]

@BoBo

Crud, I didn't thoroughly test it.

Back to the drawing board I thought it was easier than that!

[haichen]

"Yikes! If you can confirm it is from this script"

Oh I'm sorry, I didn't mean to imply that in any way. There's no connection whatsoever.

[TheArkive]

@haichen

No worries, I was just checking.

@BoBo

@TheArkive - AFAICS, the "cancel"-Button/option is suspending (therefore I'd opt to label it 'Suspend') the download bc the progress bar is stopping, not collapsing, OTOH the "resume"-Button/option looks like restarting the DL, instead of going on where it has been suspended? If I'm wrong and 'cancel' means stopping the download I'd opt for 'Exit DL' instead of 'Cancel', bc it's hard to distinguish between 'Cancel' and 'ESC'!?

The resume should be behaving properly now. As for 'Cancel' vs 'Suspend', I think in this context aren't they the same? If the user wishes to truly cancel the download, they can simply not resume.

If you want to design the UI for the example in the v1 version I'm ok with that I'll post whatever you come up with. (I find gui scripting in v1 to be headache inducing now that I've been spoiled by ahk v2.)

[TheArkive]

2022/02/28

• fixed batch download logic to behave as expected