Coding standards
Security in ResourceSpace
Developer reference
Database
Action functions
Admin functions
Ajax functions
Annotation functions
API functions
Collections functions
Comment functions
Config functions
CSV export functions
Dash functions
Debug functions
Encryption functions
Facial recognition functions
File functions
General functions
Language functions
Log functions
Login functions
Message functions
Migration functions
Node functions
PDF functions
Plugin functions
Render functions
Reporting functions
Request functions
Research functions
Slideshow functions
Theme permission functions
User functions
Video functions
Database functions
Metadata functions
Resource functions
Search functions
Map functions
Job functions
Tab functions
Test functions

collection_download_process_archive_command()

Description

Executes the archiver command when downloading a collection.

(passed by reference so can be added to)

False when further processing needed e.g. when producing a zip file.

Parameters

ColumnTypeDefaultDescription
&$dl_data array
&$zip
$filename string Download filename
&$zipfile
$dl_data array Array of collection download data from process_collection_download()
$zip object Collection zip file
$settings_id integer The index of the selected $collection_download_settings element as defined in config.php

Return

bool Will return true if there is no further work to be done as will be the case for a tar file.

Location

include/collections_functions.php lines 4737 to 4807

Definition

 
function collection_download_process_archive_command(array &$dl_data, &$zip, $filename, &$zipfile)
{

    $archiver_settings = $GLOBALS['collection_download_settings'][$dl_data['settings_id']] ?? "";

    # Execute the archiver command.
    # If $collection_download is true the $collection_download_settings are used if defined
    if ($GLOBALS['use_zip_extension'] && !$dl_data['collection_download_tar']) {
        set_processing_message($GLOBALS["lang"]["zipping"]);
        $GLOBALS["use_error_exception"] = true;
        try {
            debug("closing " . $zip->filename);
            $zip->close();
        } catch (Throwable $e) {
            debug("collection_download_process_archive_command: Unable to close zip file. Reason {$e->getMessage()}");
        }
        unset($GLOBALS["use_error_exception"]);
        set_processing_message($GLOBALS["lang"]["zipcomplete"]);
    } elseif ($dl_data['collection_download_tar']) {
        $usertempdir = get_temp_dir(false, "rs_" . $GLOBALS["userref"] . "_" . $dl_data['id']);
        header("Content-type: application/tar");
        header("Content-disposition: attachment; filename=" . $filename);
        debug("collection_download tar command: tar -cv -C " . $usertempdir . " . ");
        $cmdtempdir = escapeshellarg($usertempdir);

        debug("Calling tar command for filename " . $filename);
        passthru("find " . $cmdtempdir . ' -printf "%P\n" | tar -cv --no-recursion --dereference -C ' . $cmdtempdir . " -T -");
        return true;
    } elseif ($dl_data['archiver']) {
        set_processing_message($GLOBALS["lang"]["zipping"]);

        // Create a list of files to include
        $listfile = get_temp_dir(false, $dl_data['id']) . "/zipcmd" . $dl_data['collection'] . "-" . $dl_data['size'] . ".txt";
        //  Remove Windows line endings - fixes an issue with using tar command - somehow the file has got Windows line breaks

        $filepaths = implode(
            ($GLOBALS["config_windows"] ? "\n" : "\r\n"),
            $dl_data['includefiles']
        );
        file_put_contents($listfile, $filepaths);
        $dl_data['deletion_array'][] = $listfile;

        // Set up command line 
        $command = get_utility_path("archiver") . " [ARGUMENTS] %ZIPFILE %LISTFILEARG%LISTFILE";
        $cmdparams = [];
        // Likely be more than one argument e.g. 'a -tzip' so will need to be quoted individually
        $arguments = explode(" ", $archiver_settings["arguments"]);
        $arr_arguments = [];
        for($n = 0; $n < count($arguments); $n++) {
            $argumentstring = "%ARGUMENT{$n}";
            $arr_arguments[] = $argumentstring;
            $cmdparams[$argumentstring] = new CommandPlaceholderArg(
                $arguments[$n],
                "permitted_archiver_arguments"
            );
        }
        $command = str_replace("[ARGUMENTS]", implode(" ", $arr_arguments), $command);

        $cmdparams["%ZIPFILE"] = new CommandPlaceholderArg($zipfile, 'is_valid_rs_path');

        $cmdparams["%LISTFILEARG"] = new CommandPlaceholderArg(
            $GLOBALS["archiver_listfile_argument"],
            "permitted_archiver_arguments"
        );
        $cmdparams["%LISTFILE"] = new CommandPlaceholderArg($listfile, 'is_valid_rs_path');
        
        run_command($command, false, $cmdparams);
        set_processing_message($GLOBALS["lang"]["zipcomplete"]);
    }
    return false;
}

This article was last updated 3rd April 2025 21:35 Europe/London time based on the source file dated 3rd April 2025 16:40 Europe/London time.