fut_work.bas

Rem    This file is part of the 'File Update Tool' program.
Rem    Copyright (C) 2025 Ihar S. Areshchankau
Rem
Rem    This program is free software: you can redistribute it and/or modify
Rem    it under the terms of the GNU General Public License as published by
Rem    the Free Software Foundation, either version 3 of the License, or
Rem    (at your option) any later version.
Rem
Rem    This program is distributed in the hope that it will be useful,
Rem    but WITHOUT ANY WARRANTY; without even the implied warranty of
Rem    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
Rem    GNU General Public License for more details.
Rem
Rem    You should have received a copy of the GNU General Public License
Rem    along with this program.  If not, see <https://www.gnu.org/licenses/>.
Rem
Rem ===================================================
Rem Ìîäóëü, ðåàëèçóþùèé îñíîâíóþ ôóíêöèþ ïðîãðàììû FUT.
Rem ßçûê ïðîãðàììèðîâàíèÿ: FreeBASIC.
Rem ===================================================
#include once "file.bi"
#include once "fut_work.bai"
#include once "fut_gui.bai"
#include once "fut_stte.bai"
#include once "fut_file.bai"
#include once "fut_jrnl.bai"
#include once "fut_text.bai"
#include once "fut_lang.bai"
#include once "fut_http.bai"
Dim Shared Description As String
Dim Shared ErrorDetails As String
Rem ============================================
Rem Ïå÷àòü ñîîáùåíèÿ ïåðåä âûïîëíåíèåì äåéñòâèÿ.
Rem Âûçîâ: s - òåêñò ñîîáùåíèÿ.
Rem ============================================
Private Sub workInformBefore (ByRef s As Const String)
	Description = s
	guiPrintLn s, 0
End Sub
Rem ==================================================
Rem Ïå÷àòü ñîîáùåíèÿ î ðåçóëüòàòå âûïîëíåíèÿ äåéñòâèÿ.
Rem Âûçîâ: r - ðåçóëüòàò âûïîëíåíèÿ äåéñòâèÿ:
Rem            -1 - óñïåøíî, 0 - íåóäà÷íî.
Rem ==================================================
Private Sub workInformAfter (ByVal r As Integer)
	guiPrintLn Iif (r, langStr (13), langStr (14)), -1
	jrnlWrite jrnlMsgOperation (Description, r)
End Sub
Rem ==============================
Rem Ïå÷àòü ñîîáùåíèÿ ïðÿìî ñåé÷àñ.
Rem Âûçîâ: s - òåêñò ñîîáùåíèÿ.
Rem ==============================
Private Sub workInformJustNow (ByRef s As Const String)
	guiPrintLn s, -1
	jrnlWrite s
End Sub
Rem =================================================
Rem Ïîëó÷åíèå ôàéëà ñ îáíîâëåíèåì èç ýòàëîííîé ïàïêè.
Rem Âûçîâ: SrcFolder - ïóòü ê ýòàëîííîé ïàïêå,
Rem        TgtFolder - ïóòü ê öåëåâîé ïàïêå,
Rem        FileName - èìÿ ôàéëà ñ îáíîâëåíèåì.
Rem Âîçâðàò: -1 - ôàéë ñ îáíîâëåíèåì ïîëó÷åí,
Rem           0 - îøèáêà ïîëó÷åíèÿ ôàéëà.
Rem =================================================
Private Function RetrieveUpdate (ByRef SrcFolder As Const String, ByRef TgtFolder As String, ByRef FileName As Const String) As Integer
	Dim res As Integer, FFN1 As String, FFN2 As String, p As Integer
	FFN2 = TgtFolder + "\" + FileName
	If "HTTP://" <> UCase (Left (SrcFolder, 7)) Then
		Rem Ýòàëîííàÿ ïàïêà íàõîäèòñÿ â ôàéëîâîé ñèñòåìå.
		FFN1 = SrcFolder + "\" + FileName
		workInformBefore textSubstitute (langStr (16), FFN1 + "^" + FFN2)
		res = 0 = FileCopy (FFN1, FFN2)
		workInformAfter res
	Else
		Rem Ýòàëîííàÿ ïàïêà íàõîäèòñÿ íà âåá-ñåðâåðå.
		FFN1 = SrcFolder + Iif ("/" = Right (SrcFolder, 1), FileName, "/" + FileName)
		p = InStr (8, FFN1, "/")
		workInformBefore textSubstitute (langStr (16), FFN1 + "^" + FFN2)
		Rem Èìÿ èñõîäíîãî ôàéëà íà ñåðâåðå: Mid (FFN1, p)
		res = httpDownloadFile (Mid (FFN1, p), FFN2)
		workInformAfter res
	End If
	RetrieveUpdate = res
End Function
Rem ========================================================
Rem Óñòàíîâêà îáíîâëåíèÿ.
Rem Âûçîâ: FullUpdFileName - ïîëíîå èìÿ ôàéëà ñ îáíîâëåíèåì,
Rem        TempFolder - ïóòü ê ïàïêå äëÿ âðåìåííûõ ôàéëîâ,
Rem        TargetFolder - ïóòü ê öåëåâîé ïàïêå,
Rem        UnpackCmd - êîìàíäà ðàñïàêîâêè.
Rem Âîçâðàò: -1 - îáíîâëåíèå óñïåøíî óñòàíîâëåíî,
Rem           0 - îøèáêà óñòàíîâêè îáíîâëåíèÿ.
Rem ========================================================
Private Function InstallUpdate (ByRef FullUpdFileName As Const String, ByRef TempFolder As Const String, _
	ByRef TargetFolder As Const String, ByRef UnpackProgram As Const String, _
	ByRef UnpackArguments As Const String) As Integer
	Dim TempFolderName As String, CurDirSave As String, _
		p As Integer, res As Integer, secres As Integer
	Rem Ñîçäàíèå âðåìåííîé ïàïêè.
	TempFolderName = TempFolder + "\" + fileBaseNameOnly (FullUpdFileName) + ".tmp"
	res = 0 = MkDir (TempFolderName)
	If 0 = res Then
		Rem Ïðîèçîøëà îøèáêà ñîçäàíèÿ âðåìåííîé ïàïêè.
		ErrorDetails = textSubstitute (langStr(21), TempFolderName)
	Else
		Rem Ðàñïàêîâêà îáíîâëåíèÿ âî âðåìåííóþ ïàïêó.
		CurDirSave = CurDir
		ChDir TempFolderName
		Rem - workInformBefore UnpackProgram + " " + UnpackArguments
		res = 0 = Iif ("" <> UnpackArguments, _
			Exec (UnpackProgram, UnpackArguments + " " + FullUpdFileName), _
			Exec (UnpackProgram, FullUpdFileName))
		Rem - workInformAfter res
		ChDir CurDirSave
		If 0 = res Then
			Rem Ïðîèçîøëà îøèáêà ðàñïàêîâêè.
			ErrorDetails = langStr (22)
		End If
		If -1 = res Then
			Rem Ïðîâåðêà ñîîòâåòñòâèÿ óñëîâèÿì çàùèòû öåëåâîé ïàïêè.
			res = fileTargetFolderGuard (TempFolderName)
			If 0 = res Then
				Rem Îáíàðóæåíî íàðóøåíèå çàùèòû öåëåâîé ïàïêè
				ErrorDetails = langStr (23)
			End If
		End If
		If -1 = res Then
			Rem Êîïèðîâàíèå ôàéëîâ èç âðåìåííîé ïàïêè â öåëåâóþ.
			Rem - workInformBefore "Copy contents: " + TempFolderName + " -> " + TargetFolder
			res = fileCopyFolderContents (TempFolderName, TargetFolder)
			Rem -workInformAfter res
			If 0 = res Then
				Rem Ïðîèçîøëà îøèáêà êîïèðîâàíèÿ ôàéëîâ.
				ErrorDetails = langStr (24)
			End If
		End If
		Rem Óäàëåíèå âðåìåííîé ïàïêè ñî âñåì å¸ ñîäåðæèìûì.
		Rem - workInformBefore "Delete folder: " + TempFolderName
		secres = fileKillFolder (TempFolderName)
		Rem - workInformAfter secres
		Rem Ôèêñàöèÿ îøèáêè óäàëåíèÿ âðåìåííîé ïàïêè.
		if -1 <> secres  Then
			ErrorDetails = langStr (25)
			res = 0
		End If
	End If
	InstallUpdate = res
End Function
Rem =====================================================
Rem Ïðîöåäóðà ñ ðåàëèçàöèåé îñíîâíîé ôóíêöèè ïðîãðàììû,
Rem ïðåäíàçíà÷åííàÿ äëÿ ðàáîòû â îòäåëüíîì ïîòîêå.
Rem Âûçîâ: UserData - óêàçàòåëü íà äîïîëíèòåëüíûå äàííûå.
Rem =====================================================
Public Sub workThread (ByVal UserData As Any Ptr)
	Dim PWTD As workThreadData Pointer = UserData, n As Integer, _
		lb1 As Integer, ub1 As Integer, lb2 As Integer, ub2 As Integer, _
		i As Integer, j As Integer, FileName As String, _
		FFN1 As String, FFN2 As String, res As Integer, secres As Integer
	n = UBound (PWTD->UpdToRemove) - LBound (PWTD->UpdToRemove) + 1 + _
		UBound (PWTD->UpdToRetrieve) - LBound (PWTD->UpdToRetrieve) + 1 + _
		UBound (PWTD->UpdToInstall) - LBound (PWTD->UpdToInstall) + 1
	res = -1 
	Rem ---------------------------------------------------
	Rem Îæèäàíèå ãîòîâíîñòè ïîòîêà èíòåðôåéñà ïîëüçîâàòåëÿ.
	Rem ---------------------------------------------------
	guiWaitForReady
	Rem -----------------------------
	Rem Óäàëåíèå íåíóæíûõ îáíîâëåíèé.
	Rem -----------------------------
	lb1 = LBound (PWTD->UpdToRemove)
	ub1 = UBound (PWTD->UpdToRemove)
	i = lb1
	While -1 = res AndAlso i <= ub1
		FileName = PWTD->UpdToRemove(i)
		FFN1 = PWTD->CacheFolder + "\" + FileName
		workInformBefore textSubstitute (langStr (15), FFN1)
		res = 0 = Kill (FFN1)
		workInformAfter res
		Rem Îøèáêà óäàëåíèÿ ñòàðûõ îáíîâëåíèé íå ÿâëÿåòñÿ êðèòè÷åñêîé,
		Rem íî îøèáêà óäàëåíèÿ áóäóùèõ îáíîâëåíèé, êîòîðûõ íåò â èñòî÷íèêå,
		Rem ÿâëÿåòñÿ êðèòè÷åñêîé. Ïîýòîìó ñ÷èòàåì ëþáóþ îøèáêó óäàëåíèÿ
		Rem êðèòè÷åñêîé.
		i += 1
	Wend
	Rem ---------------------
	Rem Óñòàíîâêà îáíîâëåíèé.
	Rem ---------------------
	lb1 = LBound (PWTD->UpdToInstall)
	ub1 = UBound (PWTD->UpdToInstall)
	lb2 = LBound (PWTD->UpdToRetrieve)
	ub2 = UBound (PWTD->UpdToRetrieve)
	i = lb1
	j = lb2
	While -1 = res AndAlso i <= ub1
		FileName = PWTD->UpdToInstall(i)
		Rem Íàäî ëè ïîëó÷àòü îáíîâëåíèå?
		If j <= ub2 AndAlso FileName = PWTD->UpdToRetrieve(j) Then
			res = RetrieveUpdate (PWTD->SourceFolder, PWTD->CacheFolder, FileName)
			j += 1
		End If
		Rem Óñòàíîâêà îáíîâëåíèÿ.
		If -1 = res Then
			FFN1 = PWTD->CacheFolder + "\" + FileName
			workInformBefore textSubstitute (langStr (17), FFN1)
			res = InstallUpdate (FFN1, PWTD->TempFolder, PWTD->TargetFolder, PWTD->UnpackProgram, PWTD->UnpackArguments)
			workInformAfter res
			If -1 = res Then
				Rem Ôèêñèðîâàíèå íîâîãî ñîñòîÿíèÿ ñèñòåìû.
				Rem Ýòî, ïîæàëóé, ñàìàÿ âàæíàÿ îïåðàöèÿ.
				res = stteSetValue ("LastUpdateFileName", FileName)
				If 0 = res Then
					workInformJustNow langStr (18)
				End If
				Rem Óäàëåíèå ôàéëà óñòàíîâëåííîãî îáíîâëåíèÿ.
				Rem Ýòà îïåðàöèÿ íå ÿâëÿåòñÿ êðèòè÷íîé.
				workInformBefore textSubstitute (langStr(15), FFN1)
				secres = 0 = Kill (FFN1)
				workInformAfter secres
			Else
				Rem Äåòàëèçàöèÿ ïðè÷èíû îøèáêè îáíîâëåíèÿ, åñëè òàêîâàÿ èìååòñÿ.
				If "" <> ErrorDetails Then
					workInformJustNow "!!! " + ErrorDetails
				End If
				Rem  ñëó÷àå íåóäà÷è óñòàíîâêè îáíîâëåíèÿ ôàéë íå óäàëÿåòñÿ,
				Rem ÷òîáû ìîæíî áûëî ðàññëåäîâàòü ïðè÷èíó: íå â í¸ì ëè äåëî?
			End If
			i += 1
		End If
	Wend
	Rem ---------------------------------------------
	Rem Ïîëó÷åíèå îáíîâëåíèé äëÿ óñòàíîâêè â áóäóùåì.
	Rem ---------------------------------------------
	While -1 = res AndAlso j <= ub2
		FileName = PWTD->UpdToRetrieve(j)
		res = RetrieveUpdate (PWTD->SourceFolder, PWTD->CacheFolder, FileName)
		j += 1
	Wend
	Rem ----------------------------------------------------
	Rem Çàâåðøåíèå ðàáîòû ñ æóðíàëîì, ïîêà ðàáîòà ïðèëîæåíèÿ
	Rem íå çàáëîêèðîâàíà îæèäàíèåì ðåàêöèè ïîëüçîâàòåëÿ.
	Rem ----------------------------------------------------
	guiPrintLn langStr (19) + Iif (-1 = res, langStr (13), langStr (14)), -1
	jrnlFooter res
	If 0 = jrnlClose Then
		Dim emsg As String
		emsg = "+-+-+ " + langStr (28) + " +-+-+"
		guiPrintLn emsg, -1
	End If
	Rem ----------------------------------------
	Rem Ñîîáùåíèå î ðåçóëüòàòå âûïîëíåíèÿ çàäà÷.
	Rem ----------------------------------------
	guiNotifyWorkDone
	PWTD->BadResult = -1 <> res
End Sub