mad/hosts/quax.sh

#!    Name: quax.sh
#!  Author: kittykat
#! Version: 2024.11.29
#!    Desc: Add support for downloading and processing of urls for a new host
#!   Usage: Copy this file into the ./${ScriptDir}/hosts/ folder
#!
#!
#! ------------ REQUIRED SECTION ---------------
#! @[UPDATE] HostAndDomainRegexes: This string is loaded into mad.sh and allows dynamic handling of new url data
#! Format: '/HostCode/HostNick/HostFuncPrefix:HostDomainRegex@'
#! HostCode: <aUniqueCodeForHost> (ie. 'fh' for filehaus -- cannot be used by other hosts)
#! HostNick: What is displayed throughout MAD output (ie. 'filehaus' -- "urls.txt has 10 filehaus.."  will be displayed)
#! HostFuncPrefix: <aUniqueStringThatMustPrefixHostFunctions> (ie. 'fh' -- fh_DownloadFile(), fh_FetchFileInfo() .. )
#!   * Note: Must begin with a letter a-z (functions beginning with numbers are no bueno)
#! HostDomainRegex: The regex used to verify matching urls
HostCode='qx'
HostNick='qu.ax'
HostFuncPrefix='qx'
HostUrls='qu.ax'
HostDomainRegex='^(http|https)://(.*\.)?qu\.ax/'
#!
#! !! DO NOT UPDATE OR REMOVE !!
#! This merges the Required HostAndDomainRegexes into mad.sh
ListHostAndDomainRegexes=${ListHostAndDomainRegexes}'/'${HostCode}'/'${HostNick}'/'${HostFuncPrefix}'/'${HostUrls}':'${HostDomainRegex}'@'
#!
#!
#! ------------ (1) Host Main Download Function --------------- #
#!
#! @REQUIRED: Host Main Download function
#! Must be named specifically as such:
#! <HostFuncPrefix>_DownloadFile()
qx_DownloadFile() {
	local remote_url=${1}
	local file_url=${1}
    local filecnt=${2}
    warnAndRetryUnknownError=false
    exitDownloadError=false
    exitDownloadNotAvailable=false
	fileAlreadyDone=false
	download_inflight_path="${WorkDir}/.inflight/"
	mkdir -p "$download_inflight_path"
	completed_location="${WorkDir}/downloads/"
	tor_identity="${RANDOM}"
	finalAttempt="false"
	for ((z=0; z<=$MaxUrlRetries; z++)); do
	    if [ $z -eq  $MaxUrlRetries ] ; then
            finalAttempt="true"
	    fi  
        CLEANSTRING=${remote_url//[^a-zA-Z0-9]/}
        trap "rm -f ${WorkDir}/.flocks/${CLEANSTRING}; echo ""; tput cnorm; exit" 0 1 2 3 6 15
        if qx_FetchFileInfo $finalAttempt && qx_GetFile "${filecnt}" $((z+1)) $finalAttempt ; then
            return 0
        elif [ $z -lt $MaxUrlRetries ]; then
            if [ "${fileAlreadyDone}" == "true" ] ; then
                break
            fi
            if [[ "${warnAndRetryUnknownError}" == "true" ]] ; then
                if [ "${DebugAllEnabled}" == "true" ] ; then
                    debugHtml "${remote_url##*/}" "error" "Retry due to an unknown issue: attempt #$((z+1)) of ${MaxUrlRetries}"
                fi
            fi
            if [[ "${exitDownloadError}" == "true" || "${exitDownloadNotAvailable}" == "true" ]] ; then
                if [ "${DebugAllEnabled}" == "true" ] ; then
                    debugHtml "${remote_url##*/}" "error" "Exit due to unrecoverable issue"
                fi
                rm -f "${WorkDir}/.flocks/${remote_url//[^a-zA-Z0-9]/}"
                break
            fi
            echo -e "\n${YELLOW}A recoverable error occurred, retry attempt $((z+1))/${MaxUrlRetries}${NC}"
            sleep 3
        fi
    done
    rm -f "${WorkDir}/.flocks/${remote_url//[^a-zA-Z0-9]/}"
}
#!
#! ------------- (2) Fetch File Info Function ----------------- #
#!
qx_FetchFileInfo() {
    echo -e "${GREEN}# Fetching file info…${NC}"
    finalAttempt=$1
    CLEANSTRING=${remote_url//[^a-zA-Z0-9]/}
	trap "rm -f ${WorkDir}/.flocks/${CLEANSTRING}; echo ""; tput cnorm; exit" 0 1 2 3 6 15
    download_url=$(urlencode_literal_grouped_case_urlendingonly "$remote_url")
    tor_identity="${RANDOM}"
    file_header=$(tor_curl_request --insecure --head -L -s "$download_url")
    if [ "${DebugAllEnabled}" == "true" ] ; then
        debugHtml "${remote_url##*/}" "qx_head$j" "download_url: ${download_url}"$'\n'"${file_header}"
    fi
    if [ ! -z "$file_header" ] ; then
        if grep -Eqi '404 Not Found|HTTP.* 404' <<< "${file_header}" ; then
            echo -e "${RED}| The file has been removed (404).${NC}"
            removedDownload "${remote_url}"
            exitDownloadNotAvailable=true
            return 1
        fi
        if ! grep -Eqi 'HTTP/.* 200' <<< $file_header ; then
            echo -e "${RED}| Failed to extract file info${NC}"
            warnAndRetryUnknownError=true
            if [ "${finalAttempt}" == "true" ] ; then
        		failedRetryDownload "${remote_url}" "" ""
        	fi
            return 1
		fi
        if [ "$filename_override" == "" ] ; then
            if grep -Eqi 'filename=' <<< "${file_header}" ; then
                filename=$(grep -oP 'filename=\K.*$' <<< "${file_header}")
                filename=${filename##filename}
                filename=${filename//\"/}
                filename=${filename//[$'\t\r\n']}
            else
            	filename="${download_url##*/}"
            fi
        fi
        if ! grep -Eqi 'Content-Length' <<< "${file_header}" ; then
            echo -e "${RED}| Failed to extract file size.${NC}"                     
            if [ "${finalAttempt}" == "true" ] ; then
        		failedRetryDownload "${remote_url}" "" ""
        	fi
            return 1
        fi
    else
        echo -e "${RED}| No response. Try again later.${NC}"
        if [ "${finalAttempt}" == "true" ] ; then
    		failedRetryDownload "${remote_url}" "" ""
    	fi
        return 1
    fi
    touch ${WorkDir}/.flocks/${remote_url//[^a-zA-Z0-9]/}
	if [ ! "$filename_override" == "" ] ; then
		filename="$filename_override"
	elif [ -z $filename ] ; then
		filename=${download_url##*/}
	fi
    filename=$(sanitize_file_or_folder_name "${filename}")
    file_size_bytes=$(grep -oPi '(?<=content-length: ).*' <<< "$file_header")
    file_size_bytes=${file_size_bytes//[$'\t\r\n']}
    if [ -z $file_size_bytes ] ; then
        if [ "${finalAttempt}" == "true" ] ; then
    		failedRetryDownload "${remote_url}" "Filesize not found!" ""
    	fi
    	echo -e "${YELLOW}| Filesize not found… retry${NC}"
        return 1
    else
        file_size_readable="$(numfmt --to=iec --from=auto --format "%.2f" <<< "$file_size_bytes")"
    fi
    echo -e "${YELLOW}| File size:${NC}\t${file_size_readable}"
    file_path="${download_inflight_path}${filename}"
    echo -e "${YELLOW}| File name:${NC}\t\"${filename}\""
	flockDownload="${WorkDir}/.flocks/${filename//[^a-zA-Z0-9\.\_\-]/}.flock"
    if CheckFileSize "${remote_url}" "${file_size_bytes}" ; then
        return 1
    fi
    if CheckDownloadExists "$remote_url" "$MoveToFolder" "$filecnt" "$filename" "$file_path" "$completed_location" ; then
        return 1
    fi
	echo "${remote_url//[^a-zA-Z0-9]/}" > $flockDownload
}
#!
#! ----------- (3) Fetch File / Download File Function --------------- #
#!
qx_GetFile() {
    echo -e "${GREEN}# Downloading…"
    echo -e "${YELLOW}| File path:${NC}\t./.inflight/${filename}\n"
    fileCnt=$1
    retryCnt=$2
    finalAttempt=$3
	flockDownload="${WorkDir}/.flocks/${filename//[^a-zA-Z0-9\.\_\-]/}.flock"
    for ((j=1; j<=$MaxDownloadRetries; j++)); do
        pd_presize=0
        if [ -f "$file_path" ] ; then
            pd_presize=$(stat --format="%s" "$file_path" | tr -d '[:space:]')
        fi
        CLEANSTRING=${remote_url//[^a-zA-Z0-9]/}
        trap "rm -f ${WorkDir}/.flocks/${CLEANSTRING}; rm -f $flockDownload; echo ""; tput cnorm; exit" 0 1 2 3 6 15
        if [ "${RateMonitorEnabled}" == "true" ]; then
            tor_curl_request --insecure --speed-limit $DownloadSpeedMin --speed-time $DownloadTimeoutInterval "$download_url" --continue-at - --output "$file_path"
        else
            tor_curl_request --insecure "$download_url" --continue-at - --output "$file_path"
        fi
        received_file_size=0
        if [ -f "$file_path" ] ; then
            received_file_size=$(stat --format="%s" "$file_path" | tr -d '[:space:]')
        fi
        if CheckNoHtml "$remote_url" "$filename" "$file_path" ; then
            containsHtml=false
        else
            containsHtml=true
        fi
        downDelta=$(( received_file_size - pd_presize ))
        if [[ "${received_file_size}" -ne "${file_size_bytes}" ]] || [ "$containsHtml" == "true" ]; then	        
            if [ "${AutoRepairBadPartials}" == "true" ] && (( downDelta > 0 && downDelta < 1024 )) ; then
                if [ -f "${file_path}" ] ; then
                    if ((pd_presize > 0)); then
                        echo -e "${YELLOW}Bad node / HTML found:${NC} reverting to previous file..."
                        truncateDownload "$remote_url" "$filename" "$pd_presize" "$received_file_size"
                        truncate -s $pd_presize "${file_path}"
                    else
                        echo -e "${YELLOW}Bad node / HTML found:${NC} tainted partial removed..."
                        rm -f "${file_path}"
                    fi
                fi
                if  ((j >= $MaxDownloadRetries)) ; then
                    rm -f "$flockDownload";
                    if [ "${finalAttempt}" == "true" ] ; then
                		droppedSizeBadDownload "${remote_url}" "${filename}" "${received_file_size}"
                	fi
                    return 1
	            else
	                continue
	            fi
            elif [ "${AutoRepairBadPartials}" == "true" ] && [ "$containsHtml" == "true" ] ; then
                if [ -f "${file_path}" ] ; then
                    if ((pd_presize > 0)); then
                        echo -e "${YELLOW}Bad node / HTML found:${NC} reverting to previous file..."
                        truncateDownload "$remote_url" "$filename" "$pd_presize" "$received_file_size"
                        truncate -s $pd_presize "${file_path}"
                    else
                        echo -e "${YELLOW}Bad node / HTML found:${NC} tainted partial removed..."
                        rm -f "${file_path}"
                    fi
                fi
                if  ((j >= $MaxDownloadRetries)) ; then
                    rm -f "$flockDownload";
                    if [ "${finalAttempt}" == "true" ] ; then
                		droppedSizeBadDownload "${remote_url}" "${filename}" "${received_file_size}"
                	fi
                    return 1
	            else
	                continue
	            fi
            elif (( downDelta > 0 && downDelta < 1024 )) || [ "$containsHtml" == "true" ] ; then
                if [ -f "$file_path" ] ; then
                    rm -rf "$file_path"
                fi
                echo -e "\n${YELLOW}Bad node / HTML found:${NC} tainted partial removed..."
                if  ((j >= $MaxDownloadRetries)) ; then
                    rm -f "$flockDownload";
                    if [ "${finalAttempt}" == "true" ] ; then
                		droppedSizeBadDownload "${remote_url}" "${filename}" "${received_file_size}"
                	fi
                    return 1
	            else
	                continue
	            fi
            fi
            if [[ "${received_file_size}" -ne "${file_size_bytes}" ]]; then
                echo -e "\n${RED}Download failed, file is incomplete.${NC}"
                if  ((j >= $MaxDownloadRetries)) ; then
                    rm -f "$flockDownload";
                    if [ "${finalAttempt}" == "true" ] ; then
                		droppedSizeBadDownload "${remote_url}" "${filename}" "${received_file_size}"
                	fi
                    return 1
	            else
	                continue
	            fi
            fi
		else
		    break
        fi
    done
    rm -f "$flockDownload";
    ProcessCompletedDownload "$remote_url" "$MoveToFolder" "$filecnt" "$filename" "$file_size_bytes" "$completed_location" "$file_path"
	return 0
}
#!
#! --------------- Host Extra Functions ------------------- #
#!