mirror of
https://github.com/DanielSiepmann/tracking.git
synced 2024-05-02 18:47:37 +02:00
Allow copy of pages
Pages can not be copied by administrators as DataHandler will copy all pages, including tx_tracking_* tables. Those are not allowed on tables which will result in error messages. A test is added to simulate the action and ensure it doesn't fail with errors. Results: #52
This commit is contained in:
parent
1c669f52c7
commit
9a4f71bce4
63
Classes/Hooks/DataHandler.php
Normal file
63
Classes/Hooks/DataHandler.php
Normal file
|
|
@ -0,0 +1,63 @@
|
|||
<?php
|
||||
|
||||
namespace DanielSiepmann\Tracking\Hooks;
|
||||
|
||||
/*
|
||||
* Copyright (C) 2021 Daniel Siepmann <coding@daniel-siepmann.de>
|
||||
*
|
||||
* 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.
|
||||
*/
|
||||
|
||||
use TYPO3\CMS\Core\DataHandling\DataHandler as Typo3DataHandler;
|
||||
use TYPO3\CMS\Core\Utility\ArrayUtility;
|
||||
use TYPO3\CMS\Core\Utility\GeneralUtility;
|
||||
use TYPO3\CMS\Core\Utility\StringUtility;
|
||||
|
||||
class DataHandler
|
||||
{
|
||||
public function processCmdmap_beforeStart(Typo3DataHandler $dataHandler): void
|
||||
{
|
||||
$this->preventCopyOfTrackingTables($dataHandler);
|
||||
}
|
||||
|
||||
public static function register(): void
|
||||
{
|
||||
ArrayUtility::mergeRecursiveWithOverrule($GLOBALS['TYPO3_CONF_VARS'], [
|
||||
'SC_OPTIONS' => [
|
||||
't3lib/class.t3lib_tcemain.php' => [
|
||||
'processCmdmapClass' => [
|
||||
'tracking' => self::class,
|
||||
],
|
||||
],
|
||||
],
|
||||
]);
|
||||
}
|
||||
|
||||
private function preventCopyOfTrackingTables(Typo3DataHandler $dataHandler): void
|
||||
{
|
||||
$copyWhichTables = $dataHandler->compileAdminTables();
|
||||
|
||||
if ($dataHandler->copyWhichTables !== '*') {
|
||||
$copyWhichTables = GeneralUtility::trimExplode(',', $dataHandler->copyWhichTables, true);
|
||||
}
|
||||
|
||||
$copyWhichTables = array_filter($copyWhichTables, function (string $tableName) {
|
||||
return StringUtility::beginsWith($tableName, 'tx_tracking_') === false;
|
||||
});
|
||||
|
||||
$dataHandler->copyWhichTables = implode(',', $copyWhichTables);
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,10 @@
|
|||
pages
|
||||
,"uid","pid"
|
||||
,1,0
|
||||
,2,1
|
||||
tx_tracking_pageview
|
||||
,"uid","pid"
|
||||
,1,1
|
||||
tx_tracking_recordview
|
||||
,"uid","pid"
|
||||
,1,1
|
||||
|
Can't render this file because it has a wrong number of fields in line 2.
|
|
|
@ -0,0 +1,20 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<dataset>
|
||||
<pages>
|
||||
<pid>0</pid>
|
||||
<uid>1</uid>
|
||||
</pages>
|
||||
|
||||
<tx_tracking_pageview>
|
||||
<pid>1</pid>
|
||||
<uid>1</uid>
|
||||
<url>https://example.com/path</url>
|
||||
<user_agent>Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/80.0.3987.116 Safari/537.36</user_agent>
|
||||
<operating_system></operating_system>
|
||||
</tx_tracking_pageview>
|
||||
<tx_tracking_recordview>
|
||||
<pid>1</pid>
|
||||
<uid>1</uid>
|
||||
<url>https://example.com/path</url>
|
||||
</tx_tracking_recordview>
|
||||
</dataset>
|
||||
91
Tests/Functional/Typo3FeaturesTest.php
Normal file
91
Tests/Functional/Typo3FeaturesTest.php
Normal file
|
|
@ -0,0 +1,91 @@
|
|||
<?php
|
||||
|
||||
namespace DanielSiepmann\Tracking\Tests\Functional;
|
||||
|
||||
/*
|
||||
* Copyright (C) 2021 Daniel Siepmann <coding@daniel-siepmann.de>
|
||||
*
|
||||
* 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.
|
||||
*/
|
||||
|
||||
use DanielSiepmann\Tracking\Functional\CopyingPageWithRecordsWorks;
|
||||
use TYPO3\CMS\Core\DataHandling\DataHandler;
|
||||
use TYPO3\CMS\Core\Localization\LanguageServiceFactory;
|
||||
use TYPO3\TestingFramework\Core\Functional\FunctionalTestCase as TestCase;
|
||||
|
||||
/**
|
||||
* @covers \DanielSiepmann\Tracking\Functional\CopyingPageWithRecordsWorks
|
||||
* @testdox This extension works with TYPO3 feature:
|
||||
*/
|
||||
class Typo3FeaturesTest extends TestCase
|
||||
{
|
||||
protected $testExtensionsToLoad = [
|
||||
'typo3conf/ext/tracking',
|
||||
];
|
||||
|
||||
/**
|
||||
* @test
|
||||
* @testdox Copy pages. Tracking records will not be copied.
|
||||
*/
|
||||
public function copyContainingRecords(): void
|
||||
{
|
||||
$this->importDataSet('EXT:tracking/Tests/Functional/Fixtures/Typo3FeaturesTest/PageWithRecords.xml');
|
||||
$this->setUpBackendUserFromFixture(1);
|
||||
$GLOBALS['LANG'] = $this->getContainer()->get(LanguageServiceFactory::class)->create('default');
|
||||
|
||||
$dataHandler = new DataHandler();
|
||||
$dataHandler->start([], [
|
||||
'pages' => [
|
||||
1 => [
|
||||
'copy' => 1,
|
||||
],
|
||||
],
|
||||
]);
|
||||
$dataHandler->process_cmdmap();
|
||||
|
||||
self::assertCount(0, $dataHandler->errorLog, 'Failed with errors: ' . implode(PHP_EOL, $dataHandler->errorLog));
|
||||
$this->assertCSVDataSet(
|
||||
'EXT:tracking/Tests/Functional/ExpectedResults/Typo3FeaturesTest/CopyPasteContainingRecords.csv'
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* @test
|
||||
* @testdox Copy individual tables, but always exclude tracking tables.
|
||||
*/
|
||||
public function copyCustomTablesViaDataHandler(): void
|
||||
{
|
||||
$this->importDataSet('EXT:tracking/Tests/Functional/Fixtures/Typo3FeaturesTest/PageWithRecords.xml');
|
||||
$this->setUpBackendUserFromFixture(1);
|
||||
$GLOBALS['LANG'] = $this->getContainer()->get(LanguageServiceFactory::class)->create('default');
|
||||
|
||||
$dataHandler = new DataHandler();
|
||||
$dataHandler->copyWhichTables = 'pages,tx_tracking_pageview,tx_tracking_recordview';
|
||||
$dataHandler->start([], [
|
||||
'pages' => [
|
||||
1 => [
|
||||
'copy' => 1,
|
||||
],
|
||||
],
|
||||
]);
|
||||
$dataHandler->process_cmdmap();
|
||||
|
||||
self::assertCount(0, $dataHandler->errorLog, 'Failed with errors: ' . implode(PHP_EOL, $dataHandler->errorLog));
|
||||
$this->assertCSVDataSet(
|
||||
'EXT:tracking/Tests/Functional/ExpectedResults/Typo3FeaturesTest/CopyPasteContainingRecords.csv'
|
||||
);
|
||||
}
|
||||
}
|
||||
3
ext_localconf.php
Normal file
3
ext_localconf.php
Normal file
|
|
@ -0,0 +1,3 @@
|
|||
<?php
|
||||
|
||||
\DanielSiepmann\Tracking\Hooks\DataHandler::register();
|
||||
|
|
@ -16,4 +16,7 @@
|
|||
<rule ref="Generic.Files.LineLength.TooLong">
|
||||
<exclude-pattern>/Tests/*</exclude-pattern>
|
||||
</rule>
|
||||
<rule ref="PSR1.Methods.CamelCapsMethodName.NotCamelCaps">
|
||||
<exclude-pattern>/Classes/Hooks/DataHandler.php</exclude-pattern>
|
||||
</rule>
|
||||
</ruleset>
|
||||
|
|
|
|||
Loading…
Reference in a new issue