Skip to content

Improved invoice PDF generation flow #16251

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
rogyar wants to merge 3 commits into from
Closed

Improved invoice PDF generation flow #16251

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b3f8f2b
Improved invoice PDF generation flow
rogyar Jun 19, 2018
6e62897
Fixed unit test
rogyar Jun 24, 2018
3710bcf
Ensure that invoice_id contains an integer value
rogyar Jun 24, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 3 additions & 6 deletions app/code/Magento/Sales/Controller/Adminhtml/Invoice/AbstractInvoice/PrintAction.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,20 +48,17 @@ public function __construct(
*/
public function execute()
{
$invoiceId = $this->getRequest()->getParam('invoice_id');
$invoiceId = (int) $this->getRequest()->getParam('invoice_id');
if ($invoiceId) {
$invoice = $this->_objectManager->create(
\Magento\Sales\Api\InvoiceRepositoryInterface::class
)->get($invoiceId);
if ($invoice) {
$pdf = $this->_objectManager->create(\Magento\Sales\Model\Order\Pdf\Invoice::class)->getPdf([$invoice]);
$date = $this->_objectManager->get(
\Magento\Framework\Stdlib\DateTime\DateTime::class
)->date('Y-m-d_H-i-s');
return $this->_fileFactory->create(
'invoice' . $date . '.pdf',
"invoice_$invoiceId.pdf",
Copy link
Copy Markdown
Contributor

@phoenix128 phoenix128 Jun 24, 2018 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would it better to filter $invoiceId before? I see we are taking it directly from a request.
I am concerned about a potential path traversal attack.
I suppose changing line 51 would be just fine: $invoiceId = (int) $this->getRequest()->getParam('invoice_id');.

Copy link
Copy Markdown
Contributor Author

@rogyar rogyar Jun 24, 2018 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, Riccardo. That's a very good point. I've added the mentioned change

$pdf->render(),
DirectoryList::VAR_DIR,
DirectoryList::PDF,
'application/pdf'
);
}
Expand Down
6 changes: 1 addition & 5 deletions app/code/Magento/Sales/Test/Unit/Controller/Adminhtml/Order/Invoice/PrintActionTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,6 @@ public function testExecute()
->willReturnSelf();
$pdfMock->expects($this->once())
->method('render');
$dateTimeMock = $this->createMock(\Magento\Framework\Stdlib\DateTime\DateTime::class);

$invoiceRepository = $this->getMockBuilder(\Magento\Sales\Api\InvoiceRepositoryInterface::class)
->disableOriginalConstructor()
Expand All @@ -143,10 +142,7 @@ public function testExecute()
->method('create')
->with(\Magento\Sales\Model\Order\Pdf\Invoice::class)
->willReturn($pdfMock);
$this->objectManagerMock->expects($this->at(2))
->method('get')
->with(\Magento\Framework\Stdlib\DateTime\DateTime::class)
->willReturn($dateTimeMock);


$this->assertNull($this->controller->execute());
}
Expand Down
6 changes: 6 additions & 0 deletions lib/internal/Magento/Framework/App/Filesystem/DirectoryList.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,11 @@ class DirectoryList extends \Magento\Framework\Filesystem\DirectoryList
*/
const GENERATED_METADATA = 'metadata';

/**
* Relative directory key for generated PDFs
*/
const PDF = 'pdf';

/**
* {@inheritdoc}
*/
Expand Down Expand Up @@ -164,6 +169,7 @@ public static function getDefaultConfig()
self::GENERATED => [parent::PATH => 'generated'],
self::GENERATED_CODE => [parent::PATH => Io::DEFAULT_DIRECTORY],
self::GENERATED_METADATA => [parent::PATH => 'generated/metadata'],
self::PDF => [parent::PATH => 'var/pdf'],
];
return parent::getDefaultConfig() + $result;
}
Expand Down