S3Utils

Complexity

Total Complexity

11

Size/Duplication

Total Lines	107
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	2
A	get_file_from_s3()	0	21	1
B	put_file_into_s3()	0	27	3
B	handle_s3_ops()	0	34	5

<?php
/**
 * This class allows you to call the two S3 scripts
 * to download and upload files.
 * The scripts are executed using the CommandExecuter
  */

require_once __DIR__ . '/CommandExecuter.php';

use SA\CpeSdk;

class S3Utils
{
    public $cpeLogger;

    const S3_OPS_FAILED        = "S3_OPS_FAILED";
    const NO_OUTPUT_DATA       = "NO_OUTPUT_DATA";
    
    // External S3 Scripts
    const GET_FROM_S3          = "/../scripts/getFromS3.php";
    const PUT_IN_S3            = "/../scripts/putInS3.php";
    
    public function __construct($cpeLogger = null)
    {
        if (!$cpeLogger)
            $this->cpeLogger = new CpeSdk\CpeLogger(null, 'S3Utils');
        $this->cpeLogger = $cpeLogger;
    }

    // Get a file from S3 using external script localted in "scripts" folder
    public function get_file_from_s3(
        $bucket, 
        $filename, 
        $saveFileTo,
        $callback = null, 
        $callbackParams = null,
        $logKey = null)
    {   
        $cmd = "php " . __DIR__ . self::GET_FROM_S3;
        $cmd .= " --bucket $bucket";
        $cmd .= " --file $filename";
        $cmd .= " --to $saveFileTo";
    
        // HAndle execution
        return ($this->handle_s3_ops(
                self::GET_FROM_S3,
                $cmd, 
                $callback,
                $callbackParams,
                $logKey));
    }

    // Get a file from S3 using external script localted in "scripts" folder
    public function put_file_into_s3(
        $bucket, 
        $filename, 
        $pathToFileToSend, 
        $options, 
        $callback = null, 
        $callbackParams = null,
        $logKey = null)
    {
        $cmd  = "php " . __DIR__ . self::PUT_IN_S3;
        $cmd .= " --bucket $bucket";
        $cmd .= " --file $filename";
        $cmd .= " --from $pathToFileToSend";
        if ($options['rrs'])
            $cmd .= " --rrs";
        if ($options['encrypt'])
            $cmd .= " --encrypt";
    
        // HAndle execution
        return ($this->handle_s3_ops(
                self::PUT_IN_S3,
                $cmd, 
                $callback,
                $callbackParams,
                $logKey)
        );
    }

    // Execute S3 $cmd and capture output
    private function handle_s3_ops($caller, $cmd, $callback, $callbackParams, $logKey)
    {
        // Use executer to start external S3 script
        // The array request listening to 1 (STDOUT) and 2 (STDERR)
        $executer = new CommandExecuter($this->cpeLogger, $logKey);
        $out = $executer->execute(
            $cmd,
            1,
            array(1 => array("pipe", "w"),
                  2 => array("pipe", "w")),
            $callback,
            $callbackParams, 
            true,
            2
        );
        
        if ($out['outErr'])
            throw new CpeSdk\CpeException($out['outErr'],
                self::S3_OPS_FAILED);

        if (!$out['out'])
            throw new CpeSdk\CpeException("Script '$caller' didn't return any data !",
                self::NO_OUTPUT_DATA);
    
        if (!($decoded = json_decode($out['out'], true)))
            throw new CpeSdk\CpeException($out['out'],
                self::S3_OPS_FAILED);
    
        if ($decoded["status"] == "ERROR")
            throw new CpeSdk\CpeException($decoded["msg"],
                self::S3_OPS_FAILED);

        return ($decoded);
    }

}