GenerateCSVJob::outputHeader() - Code Metrics - Inspection of "Hardcode randomised CSRF token" - silverstripe/silverstripe-gridfieldqueuedexport - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 59108a...f6fe87 )

by Ingo

created 2016-05-23 23:28 UTC

GenerateCSVJob::outputHeader() A

↳ Parent: GenerateCSVJob

Complexity

Conditions	4
Paths	5

Size

Total Lines	17
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	17
rs	9.2
cc	4
eloc	9
nc	5
nop	2

<?php

class GenerateCSVJob extends AbstractQueuedJob {
namespace YourVendor;

class YourClass { }

    public function __construct() {
        $this->ID = uniqid();
        $this->Seperator = ',';
        $this->IncludeHeader = true;
        $this->HeadersOutput = false;
        $this->totalSteps = 1;
    }

    public function getJobType() {
        return QueuedJob::QUEUED;
    }

    public function getTitle() {
        return "Export a CSV of a Gridfield";
    }

    public function getSignature() {
        return md5(get_class($this) . '-' . $this->ID);
    }

    function setGridField($gridField) {

        $this->GridFieldName = $gridField->getName();
        $this->GridFieldURL = $gridField->Link();
    }

    function setSession($session) {

        // None of the gridfield actions are needed, and they make the stored session bigger, so pull
        // them out.
        $actionkeys = array_filter(array_keys($session), function ($i) {
            return strpos($i, 'gf_') === 0;
        });

        $session = array_diff_key($session, array_flip($actionkeys));

        // This causes problems with logins
        unset($session['HTTP_USER_AGENT']);

        $this->Session = $session;
    }

    function setColumns($columns) {

        $this->Columns = $columns;
    }

    function setSeparator($seperator) {

        $this->Separator = $seperator;
    }

    function setIncludeHeader($includeHeader) {

        $this->IncludeHeader = $includeHeader;
    }

    protected function getGridField() {
        $session = $this->Session;

        // Store state in session, and pass ID to client side.
        $state = array(
            'grid'       => $this->GridFieldName,
            'actionName' => 'findgridfield',
            'args'       => null
        );

        // Ensure $id doesn't contain only numeric characters
        $id = 'gf_' . substr(md5(serialize($state)), 0, 8);

        // Simulate CSRF token use, hardcode to a random value in our fake session
        // so GridField can evaluate it in the Director::test() execution
        $token = Injector::inst()->create('RandomGenerator')->randomToken('sha1');

        // Add new form action into session for GridField to find when Director::test is called below
        $session[$id] = $state;
        $session['SecurityID'] = $token;

        // Construct the URL
        $actionKey = 'action_gridFieldAlterAction?' . http_build_query(['StateID' => $id]);
        $actionValue = 'Find Gridfield';

        $url = Controller::join_links(
            $this->GridFieldURL,
            '?' .http_build_query([$actionKey => $actionValue, 'SecurityID' => $token])
        );

        // Restore into the current session the user the job is exporting as
        Session::set("loggedInAs", $session['loggedInAs']);

        // Then make a sub-query that should return a special SS_HTTPResponse with the gridfield object
        $res = Director::test($url, null, new Session($session), 'GET');

        // Great, it did, we can return it
        if ($res instanceof GridFieldQueuedExportButton_Response) {
            $gridField = $res->getGridField();
            $gridField->getConfig()->removeComponentsByType('GridFieldPaginator');
            $gridField->getConfig()->removeComponentsByType('GridFieldPageCount');

            return $gridField;
        } else {
            user_error('Couldn\'t restore GridField', E_USER_ERROR);
        }
    }

    protected function outputHeader($gridField, $columns) {
        $fileData = '';
        $separator = $this->Separator;

        $headers = array();

        // determine the CSV headers. If a field is callable (e.g. anonymous function) then use the
        // source name as the header instead
        foreach ($columns as $columnSource => $columnHeader) {
            $headers[] = (!is_string($columnHeader) && is_callable($columnHeader)) ? $columnSource : $columnHeader;
        }

        $fileData .= "\"" . implode("\"{$separator}\"", array_values($headers)) . "\"";
        $fileData .= "\n";

        file_put_contents('/tmp/' . $this->getSignature() . '.csv', $fileData, FILE_APPEND);
    }

    protected function outputRows($gridField, $columns, $start, $count) {
        $fileData = '';
        $separator = $this->Separator;

        $items = $gridField->getManipulatedList();
        $items = $items->limit($count, $start);

        foreach ($items as $item) {
            if (!$item->hasMethod('canView') || $item->canView()) {
                $columnData = array();

                foreach ($columns as $columnSource => $columnHeader) {
                    if (!is_string($columnHeader) && is_callable($columnHeader)) {
                        if ($item->hasMethod($columnSource)) {
                            $relObj = $item->{$columnSource}();
                        } else {
                            $relObj = $item->relObject($columnSource);
                        }

                        $value = $columnHeader($relObj);
                    } else {
                        $value = $gridField->getDataFieldValue($item, $columnSource);

                        if ($value === null) {
                            $value = $gridField->getDataFieldValue($item, $columnHeader);
                        }
                    }

                    $value = str_replace(array("\r", "\n"), "\n", $value);
                    $columnData[] = '"' . str_replace('"', '""', $value) . '"';
                }

                $fileData .= implode($separator, $columnData);
                $fileData .= "\n";
            }

            if ($item->hasMethod('destroy')) {
                $item->destroy();
            }
        }

        file_put_contents('/tmp/' . $this->getSignature() . '.csv', $fileData, FILE_APPEND);
    }


    public function setup() {
        $gridField = $this->getGridField();
        $this->totalSteps = $gridField->getManipulatedList()->count();
    }

    /**
     * Generate export fields for CSV.
     *
     * @param GridField $gridField
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     * @return array
     */
    public function process() {
        $gridField = $this->getGridField();
        $columns = $this->Columns ?: singleton($gridField->getModelClass())->summaryFields();

        if ($this->IncludeHeader && !$this->HeadersOutput) {
            $this->outputHeader($gridField, $columns);
            $this->HeadersOutput = true;
        }

        $this->outputRows($gridField, $columns, $this->currentStep, 100);

        $this->currentStep += 100;

        if ($this->currentStep >= $this->totalSteps) {
            $this->isComplete = true;
        }
    }
}


1			<?php
2
3			class GenerateCSVJob extends AbstractQueuedJob {
			0 ignored issues – show Coding Style Compatibility introduced 2016-05-23 21:15 UTC by Report Bug Copy Issue Report PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions. You can fix this by adding a namespace to your class: namespace YourVendor; class YourClass { } When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries. Loading history...
4
5			public function __construct() {
6			$this->ID = uniqid();
7			$this->Seperator = ',';
8			$this->IncludeHeader = true;
9			$this->HeadersOutput = false;
10			$this->totalSteps = 1;
11			}
12
13			public function getJobType() {
14			return QueuedJob::QUEUED;
15			}
16
17			public function getTitle() {
18			return "Export a CSV of a Gridfield";
19			}
20
21			public function getSignature() {
22			return md5(get_class($this) . '-' . $this->ID);
23			}
24
25			function setGridField($gridField) {
			0 ignored issues – show Best Practice introduced 2016-05-23 21:15 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
26			$this->GridFieldName = $gridField->getName();
27			$this->GridFieldURL = $gridField->Link();
28			}
29
30			function setSession($session) {
			0 ignored issues – show Best Practice introduced 2016-05-23 21:15 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
31			// None of the gridfield actions are needed, and they make the stored session bigger, so pull
32			// them out.
33			$actionkeys = array_filter(array_keys($session), function ($i) {
34			return strpos($i, 'gf_') === 0;
35			});
36
37			$session = array_diff_key($session, array_flip($actionkeys));
38
39			// This causes problems with logins
40			unset($session['HTTP_USER_AGENT']);
41
42			$this->Session = $session;
43			}
44
45			function setColumns($columns) {
			0 ignored issues – show Best Practice introduced 2016-05-23 21:15 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
46			$this->Columns = $columns;
47			}
48
49			function setSeparator($seperator) {
			0 ignored issues – show Best Practice introduced 2016-05-23 21:15 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
50			$this->Separator = $seperator;
51			}
52
53			function setIncludeHeader($includeHeader) {
			0 ignored issues – show Best Practice introduced 2016-05-23 21:15 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
54			$this->IncludeHeader = $includeHeader;
55			}
56
57			protected function getGridField() {
58			$session = $this->Session;
59
60			// Store state in session, and pass ID to client side.
61			$state = array(
62			'grid' => $this->GridFieldName,
63			'actionName' => 'findgridfield',
64			'args' => null
65			);
66
67			// Ensure $id doesn't contain only numeric characters
68			$id = 'gf_' . substr(md5(serialize($state)), 0, 8);
69
70			// Simulate CSRF token use, hardcode to a random value in our fake session
71			// so GridField can evaluate it in the Director::test() execution
72			$token = Injector::inst()->create('RandomGenerator')->randomToken('sha1');
73
74			// Add new form action into session for GridField to find when Director::test is called below
75			$session[$id] = $state;
76			$session['SecurityID'] = $token;
77
78			// Construct the URL
79			$actionKey = 'action_gridFieldAlterAction?' . http_build_query(['StateID' => $id]);
80			$actionValue = 'Find Gridfield';
81
82			$url = Controller::join_links(
83			$this->GridFieldURL,
84			'?' .http_build_query([$actionKey => $actionValue, 'SecurityID' => $token])
85			);
86
87			// Restore into the current session the user the job is exporting as
88			Session::set("loggedInAs", $session['loggedInAs']);
89
90			// Then make a sub-query that should return a special SS_HTTPResponse with the gridfield object
91			$res = Director::test($url, null, new Session($session), 'GET');
92
93			// Great, it did, we can return it
94			if ($res instanceof GridFieldQueuedExportButton_Response) {
95			$gridField = $res->getGridField();
96			$gridField->getConfig()->removeComponentsByType('GridFieldPaginator');
97			$gridField->getConfig()->removeComponentsByType('GridFieldPageCount');
98
99			return $gridField;
100			} else {
101			user_error('Couldn\'t restore GridField', E_USER_ERROR);
102			}
103			}
104
105			protected function outputHeader($gridField, $columns) {
106			$fileData = '';
107			$separator = $this->Separator;
108
109			$headers = array();
110
111			// determine the CSV headers. If a field is callable (e.g. anonymous function) then use the
112			// source name as the header instead
113			foreach ($columns as $columnSource => $columnHeader) {
114			$headers[] = (!is_string($columnHeader) && is_callable($columnHeader)) ? $columnSource : $columnHeader;
115			}
116
117			$fileData .= "\"" . implode("\"{$separator}\"", array_values($headers)) . "\"";
118			$fileData .= "\n";
119
120			file_put_contents('/tmp/' . $this->getSignature() . '.csv', $fileData, FILE_APPEND);
121			}
122
123			protected function outputRows($gridField, $columns, $start, $count) {
124			$fileData = '';
125			$separator = $this->Separator;
126
127			$items = $gridField->getManipulatedList();
128			$items = $items->limit($count, $start);
129
130			foreach ($items as $item) {
131			if (!$item->hasMethod('canView') \|\| $item->canView()) {
132			$columnData = array();
133
134			foreach ($columns as $columnSource => $columnHeader) {
135			if (!is_string($columnHeader) && is_callable($columnHeader)) {
136			if ($item->hasMethod($columnSource)) {
137			$relObj = $item->{$columnSource}();
138			} else {
139			$relObj = $item->relObject($columnSource);
140			}
141
142			$value = $columnHeader($relObj);
143			} else {
144			$value = $gridField->getDataFieldValue($item, $columnSource);
145
146			if ($value === null) {
147			$value = $gridField->getDataFieldValue($item, $columnHeader);
148			}
149			}
150
151			$value = str_replace(array("\r", "\n"), "\n", $value);
152			$columnData[] = '"' . str_replace('"', '""', $value) . '"';
153			}
154
155			$fileData .= implode($separator, $columnData);
156			$fileData .= "\n";
157			}
158
159			if ($item->hasMethod('destroy')) {
160			$item->destroy();
161			}
162			}
163
164			file_put_contents('/tmp/' . $this->getSignature() . '.csv', $fileData, FILE_APPEND);
165			}
166
167
168			public function setup() {
169			$gridField = $this->getGridField();
170			$this->totalSteps = $gridField->getManipulatedList()->count();
171			}
172
173			/**
174			* Generate export fields for CSV.
175			*
176			* @param GridField $gridField
			0 ignored issues – show Bug introduced 2016-05-23 21:15 UTC by Report Bug Copy Issue Report There is no parameter named `$gridField`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
177			* @return array
178			*/
179			public function process() {
180			$gridField = $this->getGridField();
181			$columns = $this->Columns ?: singleton($gridField->getModelClass())->summaryFields();
182
183			if ($this->IncludeHeader && !$this->HeadersOutput) {
184			$this->outputHeader($gridField, $columns);
185			$this->HeadersOutput = true;
186			}
187
188			$this->outputRows($gridField, $columns, $this->currentStep, 100);
189
190			$this->currentStep += 100;
191
192			if ($this->currentStep >= $this->totalSteps) {
193			$this->isComplete = true;
194			}
195			}
196			}
197

silverstripe / silverstripe-gridfieldqueuedexport

Push — master ( 59108a...f6fe87 )

GenerateCSVJob::outputHeader() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like