ValidateAssetActivity::do_activity() - Code Metrics - Inspection of "Merge branch 'SFN-migration' of github.com:sportar..." - sportarchive/CloudTranscode - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 22eeb1...8ed10b )

unknown

created 2017-03-02 17:09 UTC

ValidateAssetActivity::do_activity() C

↳ Parent: Project

Complexity

Conditions	9
Paths	12

Size

Total Lines	75
Code Lines	42

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	9
eloc	42
nc	12
nop	1
dl	0
loc	75
rs	5.875
c	0
b	0
f	0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	ValidateAssetActivity::__construct()	0	13	2
A	ValidateAssetActivity::writefn()	0	13	2

How to fix Long Method

#!/usr/bin/php

<?php

/*
 *   This class validate input assets and get mime type and metadata 
 *   Using the ValidateAsset activity you can confirm your asset can be transcoded
 *
 *   Copyright (C) 2016  BFan Sports - Sport Archive Inc.
 *
 *   This program is free software; you can redistribute it and/or modify
 *   it under the terms of the GNU General Public License as published by
 *   the Free Software Foundation; either version 2 of the License, or
 *   (at your option) any later version.
 *
 *   This program is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *   GNU General Public License for more details.
 *
 *   You should have received a copy of the GNU General Public License along
 *   with this program; if not, write to the Free Software Foundation, Inc.,
 *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

require_once __DIR__.'/BasicActivity.php';

use SA\CpeSdk;

class ValidateAssetActivity extends BasicActivity
{
    private $finfo;

    private $s3;
    private $curl_data = '';
    
    public function __construct($client = null, $params, $debug, $cpeLogger)
    {
        # Check if preper env vars are setup
        if (!($region = getenv("AWS_DEFAULT_REGION")))
            throw new CpeSdk\CpeException("Set 'AWS_DEFAULT_REGION' environment variable!");
        
        parent::__construct($client, $params, $debug, $cpeLogger);
        
        $this->s3 = new \Aws\S3\S3Client([
            "version" => "latest",
            "region"  => $region
        ]);
    }

    // Used to limit the curl download in case of an HTTP encode
    private function writefn($ch, $chunk)
    {
        static $limit = 1024; // 500 bytes, it's only a test
        
        $len = strlen($this->curl_data) + strlen($chunk);
        if ($len >= $limit ) {
            $this->curl_data .= substr($chunk, 0, $limit-strlen($this->curl_data));
            return -1;
        }
        
        $this->curl_data .= $chunk;
        return strlen($chunk);
    }
    
    // Perform the activity
    public function process($task)
    {
        $this->cpeLogger->logOut(
            "INFO",
            basename(__FILE__),
            "Preparing Asset validation ...",
            $this->logKey
        );

        // Call parent process:
        parent::process($task);
        
        $this->activityHeartbeat();
        $tmpFile = tempnam(sys_get_temp_dir(), 'ct');

        if (isset($this->input->{'input_asset'}->{'http'})) {
            $ch = curl_init();
            curl_setopt($ch, CURLOPT_URL, $this->input->{'input_asset'}->{'http'});
            curl_setopt($ch, CURLOPT_RANGE, '0-1024');
            curl_setopt($ch, CURLOPT_WRITEFUNCTION, array($this, 'writefn'));
            curl_exec($ch);
            curl_close($ch);
            $chunk = $this->curl_data;
        }
        else if (isset($this->input->{'input_asset'}->{'bucket'}) &&
                 isset($this->input->{'input_asset'}->{'file'})) {
            // Fetch first 1 KiB of the file for Magic number validation
            $obj = $this->s3->getObject([
                'Bucket' => $this->input->{'input_asset'}->{'bucket'},
                'Key'    => $this->input->{'input_asset'}->{'file'},
                'Range'  => 'bytes=0-1024'
            ]);
            $chunk = (string) $obj['Body'];
        }
        
        $this->activityHeartbeat();

        // Determine file type
        file_put_contents($tmpFile, $chunk);
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
        $mime = trim((new CommandExecuter($this->cpeLogger, $this->logKey))->execute(
            'file -b --mime-type '.escapeshellarg($tmpFile))['out']);
        $type = substr($mime, 0, strpos($mime, '/'));

        if ($this->debug)
            $this->cpeLogger->logOut(
                "DEBUG",
                basename(__FILE__),
                "File meta information gathered. Mime: $mime | Type: $type",
                $this->logKey
        );

        // Load the right transcoder base on input_type
        // Get asset detailed info
        switch ($type)
        {
        case 'audio':
        case 'video':
        case 'image':
        default:
            require_once __DIR__.'/transcoders/VideoTranscoder.php';

            // Initiate transcoder obj
            $videoTranscoder = new VideoTranscoder($this, $task);
            // Get input video information
            $assetInfo = $videoTranscoder->getAssetInfo($this->inputFilePath);

            // Liberate memory
            unset($videoTranscoder);
        }

        if ($mime === 'application/octet-stream' && isset($assetInfo->streams)) {
            // Check all stream types
            foreach ($assetInfo->streams as $stream) {
                if ($stream->codec_type === 'video') {
                    // For a video type, set type to video and break
                    $type = 'video';
                    break;
                } elseif ($stream->codec_type === 'audio') {
                    // For an audio type, set to audio, but don't break
                    // in case there's a video stream later
                    $type = 'audio';
                }
            }
        }
        
        $assetInfo->mime = $mime;
        $assetInfo->type = $type;

        $result['input_asset']     = $this->input->{'input_asset'};
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
        $result['input_metadata']  = $assetInfo;
        $result['output_assets']   = $this->input->{'output_assets'};
        
        return json_encode($result);
    }
}


/*
 ***************************
 * Activity Startup SCRIPT
 ***************************
*/

// Usage
function usage()
/**
 * @ignore
 */
function getUser() {

}

function getUser($id, $realm) {

}
{
    echo("Usage: php ". basename(__FILE__) . " -A <Snf ARN> [-C <client class path>] [-N <activity name>] [-h] [-d] [-l <log path>]\n");
    echo("-h: Print this help\n");
    echo("-d: Debug mode\n");
    echo("-l <log_path>: Location where logs will be dumped in (folder).\n");
    echo("-A <activity_name>: Activity name this Poller can process. Or use 'SNF_ACTIVITY_ARN' environment variable. Command line arguments have precedence\n");
    echo("-C <client class path>: Path to the PHP file that contains the class that implements your Client Interface\n");
    echo("-N <activity name>: Override the default activity name. Useful if you want to have different client interfaces for the same activity type.\n");
    exit(0);
}

// Check command line input parameters
function check_activity_arguments()
/**
 * @ignore
 */
function getUser() {

}

function getUser($id, $realm) {

}
{
    // Filling the globals with input
    global $arn;
    global $logPath;
    global $debug;
    global $clientClassPath;
    global $name;
    
    // Handle input parameters
    if (!($options = getopt("N:A:l:C:hd")))
        usage();
    
    if (isset($options['h']))
        usage();

    // Debug
    if (isset($options['d']))
        $debug = true;

    if (isset($options['A']) && $options['A']) {
        $arn = $options['A'];
    } else if (getenv('SNF_ACTIVITY_ARN')) {
        $arn = getenv('SNF_ACTIVITY_ARN');
    } else {
        echo "ERROR: You must provide the ARN of your activity (Sfn ARN). Use option [-A <ARN>] or environment variable: 'SNF_ACTIVITY_ARN'\n";
        usage();
    }

    if (isset($options['C']) && $options['C']) {
        $clientClassPath = $options['C'];
    }

    if (isset($options['N']) && $options['N']) {
        $name = $options['N'];
    }
    
    if (isset($options['l']))
        $logPath = $options['l'];
}


/*
 * START THE SCRIPT ACTITIVY
 */

// Globals
$debug = false;
$logPath = null;
$arn;
$name = 'ValidateAsset';
$clientClassPath = null;

check_activity_arguments();

$cpeLogger = new SA\CpeSdk\CpeLogger($name, $logPath);
$cpeLogger->logOut("INFO", basename(__FILE__),
                   "\033[1mStarting activity\033[0m: $name");

// We instanciate the Activity 'ValidateAsset' and give it a name for Snf
$activityPoller = new ValidateAssetActivity(
    $clientClassPath,
    [
        'arn'  => $arn,
        'name' => $name
    ],
    $debug,
    $cpeLogger);

// Initiate the polling loop and will call your `process` function upon trigger
$activityPoller->doActivity();




1		#!/usr/bin/php
2
3		<?php
4
5		/*
6		* This class validate input assets and get mime type and metadata
7		* Using the ValidateAsset activity you can confirm your asset can be transcoded
8		*
9		* Copyright (C) 2016 BFan Sports - Sport Archive Inc.
10		*
11		* This program is free software; you can redistribute it and/or modify
12		* it under the terms of the GNU General Public License as published by
13		* the Free Software Foundation; either version 2 of the License, or
14		* (at your option) any later version.
15		*
16		* This program is distributed in the hope that it will be useful,
17		* but WITHOUT ANY WARRANTY; without even the implied warranty of
18		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19		* GNU General Public License for more details.
20		*
21		* You should have received a copy of the GNU General Public License along
22		* with this program; if not, write to the Free Software Foundation, Inc.,
23		* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
24		*/
25
26		require_once __DIR__.'/BasicActivity.php';
27
28		use SA\CpeSdk;
29
30		class ValidateAssetActivity extends BasicActivity
31		{
32		private $finfo;
		0 ignored issues – show Unused Code introduced 2017-03-02 17:16 UTC by Report Bug Copy Issue Report The property `$finfo` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
33		private $s3;
34		private $curl_data = '';
35
36		public function __construct($client = null, $params, $debug, $cpeLogger)
37		{
38		# Check if preper env vars are setup
39		if (!($region = getenv("AWS_DEFAULT_REGION")))
40		throw new CpeSdk\CpeException("Set 'AWS_DEFAULT_REGION' environment variable!");
41
42		parent::__construct($client, $params, $debug, $cpeLogger);
43
44		$this->s3 = new \Aws\S3\S3Client([
45		"version" => "latest",
46		"region" => $region
47		]);
48		}
49
50		// Used to limit the curl download in case of an HTTP encode
51		private function writefn($ch, $chunk)
52		{
53		static $limit = 1024; // 500 bytes, it's only a test
54
55		$len = strlen($this->curl_data) + strlen($chunk);
56		if ($len >= $limit ) {
57		$this->curl_data .= substr($chunk, 0, $limit-strlen($this->curl_data));
58		return -1;
59		}
60
61		$this->curl_data .= $chunk;
62		return strlen($chunk);
63		}
64
65		// Perform the activity
66		public function process($task)
67		{
68		$this->cpeLogger->logOut(
69		"INFO",
70		basename(__FILE__),
71		"Preparing Asset validation ...",
72		$this->logKey
73		);
74
75		// Call parent process:
76		parent::process($task);
77
78		$this->activityHeartbeat();
79		$tmpFile = tempnam(sys_get_temp_dir(), 'ct');
80
81		if (isset($this->input->{'input_asset'}->{'http'})) {
82		$ch = curl_init();
83		curl_setopt($ch, CURLOPT_URL, $this->input->{'input_asset'}->{'http'});
84		curl_setopt($ch, CURLOPT_RANGE, '0-1024');
85		curl_setopt($ch, CURLOPT_WRITEFUNCTION, array($this, 'writefn'));
86		curl_exec($ch);
87		curl_close($ch);
88		$chunk = $this->curl_data;
89		}
90		else if (isset($this->input->{'input_asset'}->{'bucket'}) &&
91		isset($this->input->{'input_asset'}->{'file'})) {
92		// Fetch first 1 KiB of the file for Magic number validation
93		$obj = $this->s3->getObject([
94		'Bucket' => $this->input->{'input_asset'}->{'bucket'},
95		'Key' => $this->input->{'input_asset'}->{'file'},
96		'Range' => 'bytes=0-1024'
97		]);
98		$chunk = (string) $obj['Body'];
99		}
100
101		$this->activityHeartbeat();
102
103		// Determine file type
104		file_put_contents($tmpFile, $chunk);
		0 ignored issues – show Bug introduced 2017-03-02 17:16 UTC by Report Bug Copy Issue Report The variable `$chunk` does not seem to be defined for all execution paths leading up to this point. If you define a variable conditionally, it can happen that it is not defined for all execution paths. Let’s take a look at an example: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } // $x is potentially undefined here. echo $x; } In the above example, the variable `$x` is defined if you pass “foo” or “bar” as argument for `$a`. However, since the `switch` statement has no default case statement, if you pass any other value, the variable `$x` would be undefined. Available Fixes Check for existence of the variable explicitly: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } if (isset($x)) { // Make sure it's always set. echo $x; } } Define a default value for the variable: function myFunction($a) { $x = ''; // Set a default which gets overridden for certain paths. switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } echo $x; } Add a value for the missing path: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; // We add support for the missing case. default: $x = ''; break; } echo $x; } Loading history...
105		$mime = trim((new CommandExecuter($this->cpeLogger, $this->logKey))->execute(
106		'file -b --mime-type '.escapeshellarg($tmpFile))['out']);
107		$type = substr($mime, 0, strpos($mime, '/'));
108
109		if ($this->debug)
110		$this->cpeLogger->logOut(
111		"DEBUG",
112		basename(__FILE__),
113		"File meta information gathered. Mime: $mime \| Type: $type",
114		$this->logKey
115		);
116
117		// Load the right transcoder base on input_type
118		// Get asset detailed info
119		switch ($type)
120		{
121		case 'audio':
122		case 'video':
123		case 'image':
124		default:
125		require_once __DIR__.'/transcoders/VideoTranscoder.php';
126
127		// Initiate transcoder obj
128		$videoTranscoder = new VideoTranscoder($this, $task);
129		// Get input video information
130		$assetInfo = $videoTranscoder->getAssetInfo($this->inputFilePath);
131
132		// Liberate memory
133		unset($videoTranscoder);
134		}
135
136		if ($mime === 'application/octet-stream' && isset($assetInfo->streams)) {
137		// Check all stream types
138		foreach ($assetInfo->streams as $stream) {
139		if ($stream->codec_type === 'video') {
140		// For a video type, set type to video and break
141		$type = 'video';
142		break;
143		} elseif ($stream->codec_type === 'audio') {
144		// For an audio type, set to audio, but don't break
145		// in case there's a video stream later
146		$type = 'audio';
147		}
148		}
149		}
150
151		$assetInfo->mime = $mime;
152		$assetInfo->type = $type;
153
154		$result['input_asset'] = $this->input->{'input_asset'};
		0 ignored issues – show Coding Style Comprehensibility introduced 2017-03-02 17:16 UTC by Report Bug Copy Issue Report `$result` was never initialized. Although not strictly required by PHP, it is generally a good practice to add `$result = array();` before regardless. Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code. Let’s take a look at an example: foreach ($collection as $item) { $myArray['foo'] = $item->getFoo(); if ($item->hasBar()) { $myArray['bar'] = $item->getBar(); } // do something with $myArray } As you can see in this example, the array `$myArray` is initialized the first time when the foreach loop is entered. You can also see that the value of the `bar` key is only written conditionally; thus, its value might result from a previous iteration. This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization `$myArray = array()` either outside or inside the foreach loop. Loading history...
155		$result['input_metadata'] = $assetInfo;
156		$result['output_assets'] = $this->input->{'output_assets'};
157
158		return json_encode($result);
159		}
160		}
161
162
163		/*
164		***************************
165		* Activity Startup SCRIPT
166		***************************
167		*/
168
169		// Usage
170	View Code Duplication	function usage()
		0 ignored issues – show Best Practice introduced 2017-03-02 17:16 UTC by Report Bug Copy Issue Report The function `usage()` has been defined more than once; this definition is ignored, only the first definition in `src/activities/TranscodeAssetActivity.php` (L282-292) is considered. This check looks for functions that have already been defined in other files. Some Codebases, like WordPress, make a practice of defining functions multiple times. This may lead to problems with the detection of function parameters and types. If you really need to do this, you can mark the duplicate definition with the `@ignore` annotation. /** * @ignore */ function getUser() { } function getUser($id, $realm) { } See also the PhpDoc documentation for @ignore. Loading history... Duplication introduced 2017-03-02 17:16 UTC by Report Bug Copy Issue Report This function seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
171		{
172		echo("Usage: php ". basename(__FILE__) . " -A <Snf ARN> [-C <client class path>] [-N <activity name>] [-h] [-d] [-l <log path>]\n");
173		echo("-h: Print this help\n");
174		echo("-d: Debug mode\n");
175		echo("-l <log_path>: Location where logs will be dumped in (folder).\n");
176		echo("-A <activity_name>: Activity name this Poller can process. Or use 'SNF_ACTIVITY_ARN' environment variable. Command line arguments have precedence\n");
177		echo("-C <client class path>: Path to the PHP file that contains the class that implements your Client Interface\n");
178		echo("-N <activity name>: Override the default activity name. Useful if you want to have different client interfaces for the same activity type.\n");
179		exit(0);
180		}
181
182		// Check command line input parameters
183	View Code Duplication	function check_activity_arguments()
		0 ignored issues – show Best Practice introduced 2017-03-02 17:16 UTC by Report Bug Copy Issue Report The function `check_activity_arguments()` has been defined more than once; this definition is ignored, only the first definition in `src/activities/TranscodeAssetActivity.php` (L295-334) is considered. This check looks for functions that have already been defined in other files. Some Codebases, like WordPress, make a practice of defining functions multiple times. This may lead to problems with the detection of function parameters and types. If you really need to do this, you can mark the duplicate definition with the `@ignore` annotation. /** * @ignore */ function getUser() { } function getUser($id, $realm) { } See also the PhpDoc documentation for @ignore. Loading history... Duplication introduced 2017-03-02 17:16 UTC by Report Bug Copy Issue Report This function seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
184		{
185		// Filling the globals with input
186		global $arn;
187		global $logPath;
188		global $debug;
189		global $clientClassPath;
190		global $name;
191
192		// Handle input parameters
193		if (!($options = getopt("N:A:l:C:hd")))
194		usage();
195
196		if (isset($options['h']))
197		usage();
198
199		// Debug
200		if (isset($options['d']))
201		$debug = true;
202
203		if (isset($options['A']) && $options['A']) {
204		$arn = $options['A'];
205		} else if (getenv('SNF_ACTIVITY_ARN')) {
206		$arn = getenv('SNF_ACTIVITY_ARN');
207		} else {
208		echo "ERROR: You must provide the ARN of your activity (Sfn ARN). Use option [-A <ARN>] or environment variable: 'SNF_ACTIVITY_ARN'\n";
209		usage();
210		}
211
212		if (isset($options['C']) && $options['C']) {
213		$clientClassPath = $options['C'];
214		}
215
216		if (isset($options['N']) && $options['N']) {
217		$name = $options['N'];
218		}
219
220		if (isset($options['l']))
221		$logPath = $options['l'];
222		}
223
224
225		/*
226		* START THE SCRIPT ACTITIVY
227		*/
228
229		// Globals
230		$debug = false;
231		$logPath = null;
232		$arn;
233		$name = 'ValidateAsset';
234		$clientClassPath = null;
235
236		check_activity_arguments();
237
238		$cpeLogger = new SA\CpeSdk\CpeLogger($name, $logPath);
239		$cpeLogger->logOut("INFO", basename(__FILE__),
240		"\033[1mStarting activity\033[0m: $name");
241
242		// We instanciate the Activity 'ValidateAsset' and give it a name for Snf
243		$activityPoller = new ValidateAssetActivity(
244		$clientClassPath,
245		[
246		'arn' => $arn,
247		'name' => $name
248		],
249		$debug,
250		$cpeLogger);
251
252		// Initiate the polling loop and will call your `process` function upon trigger
253		$activityPoller->doActivity();
254
255
256

sportarchive / CloudTranscode

Push — master ( 22eeb1...8ed10b )

ValidateAssetActivity::do_activity() C

Complexity

Size

Duplication

Importance

2 Methods

How to fix Long Method

Long Method

Available Fixes

Duplication Side-by-Side

Filter issues like