DeletedRecords.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Recycler\Domain\Model;

class DeletedRecords {

    protected $deletedRows = array();

    protected $limit = '';

    protected $table = array();

    protected $recyclerHelper;

    public $label;

    public $title;

    /************************************************************
     * GET DATA FUNCTIONS
     *
     *
     ************************************************************/
    public function loadData($id, $table, $depth, $limit = '', $filter = '') {
        // set the limit
        $this->limit = trim($limit);
        if ($table) {
            if (array_key_exists($table, $GLOBALS['TCA'])) {
                $this->table[] = $table;
                $this->setData($id, $table, $depth, $GLOBALS['TCA'][$table]['ctrl'], $filter);
            }
        } else {
            foreach ($GLOBALS['TCA'] as $tableKey => $tableValue) {
                // only go into this table if the limit allows it
                if ($this->limit != '') {
                    $parts = \TYPO3\CMS\Core\Utility\GeneralUtility::trimExplode(',', $this->limit);
                    // abort loop if LIMIT 0,0
                    if ($parts[0] == 0 && $parts[1] == 0) {
                        break;
                    }
                }
                $this->table[] = $tableKey;
                $this->setData($id, $tableKey, $depth, $tableValue['ctrl'], $filter);
            }
        }
        return $this;
    }

    public function getTotalCount($id, $table, $depth, $filter) {
        $deletedRecords = $this->loadData($id, $table, $depth, '', $filter)->getDeletedRows();
        $countTotal = 0;
        foreach ($this->table as $tableName) {
            $countTotal += count($deletedRecords[$tableName]);
        }
        return $countTotal;
    }

    protected function setData($id = 0, $table, $depth, $tcaCtrl, $filter) {
        $id = (int)$id;
        if (array_key_exists('delete', $tcaCtrl)) {
            // find the 'deleted' field for this table
            $deletedField = \TYPO3\CMS\Recycler\Utility\RecyclerUtility::getDeletedField($table);
            // create the filter WHERE-clause
            if (trim($filter) != '') {
                $filterWhere = ' AND (' . (\TYPO3\CMS\Core\Utility\MathUtility::canBeInterpretedAsInteger($filter) ? 'uid = ' . $filter . ' OR pid = ' . $filter . ' OR ' : '') . $tcaCtrl['label'] . ' LIKE "%' . $this->escapeValueForLike($filter, $table) . '%"' . ')';
            }
            // get the limit
            if ($this->limit != '') {
                // count the number of deleted records for this pid
                $deletedCount = $GLOBALS['TYPO3_DB']->exec_SELECTcountRows('uid', $table, $deletedField . '<>0 AND pid = ' . $id . $filterWhere);
                // split the limit
                $parts = \TYPO3\CMS\Core\Utility\GeneralUtility::trimExplode(',', $this->limit);
                $offset = $parts[0];
                $rowCount = $parts[1];
                // subtract the number of deleted records from the limit's offset
                $result = $offset - $deletedCount;
                // if the result is >= 0
                if ($result >= 0) {
                    // store the new offset in the limit and go into the next depth
                    $offset = $result;
                    $this->limit = implode(',', array($offset, $rowCount));
                    // do NOT query this depth; limit also does not need to be set, we set it anyways
                    $allowQuery = FALSE;
                    $allowDepth = TRUE;
                    $limit = '';
                } else {
                    // the offset for the temporary limit has to remain like the original offset
                    // in case the original offset was just crossed by the amount of deleted records
                    if ($offset != 0) {
                        $tempOffset = $offset;
                    } else {
                        $tempOffset = 0;
                    }
                    // set the offset in the limit to 0
                    $newOffset = 0;
                    // convert to negative result to the positive equivalent
                    $absResult = abs($result);
                    // if the result now is > limit's row count
                    if ($absResult > $rowCount) {
                        // use the limit's row count as the temporary limit
                        $limit = implode(',', array($tempOffset, $rowCount));
                        // set the limit's row count to 0
                        $this->limit = implode(',', array($newOffset, 0));
                        // do not go into new depth
                        $allowDepth = FALSE;
                    } else {
                        // if the result now is <= limit's row count
                        // use the result as the temporary limit
                        $limit = implode(',', array($tempOffset, $absResult));
                        // subtract the result from the row count
                        $newCount = $rowCount - $absResult;
                        // store the new result in the limit's row count
                        $this->limit = implode(',', array($newOffset, $newCount));
                        // if the new row count is > 0
                        if ($newCount > 0) {
                            // go into new depth
                            $allowDepth = TRUE;
                        } else {
                            // if the new row count is <= 0 (only =0 makes sense though)
                            // do not go into new depth
                            $allowDepth = FALSE;
                        }
                    }
                    // allow query for this depth
                    $allowQuery = TRUE;
                }
            } else {
                $limit = '';
                $allowDepth = TRUE;
                $allowQuery = TRUE;
            }
            // query for actual deleted records
            if ($allowQuery) {
                $recordsToCheck = \TYPO3\CMS\Backend\Utility\BackendUtility::getRecordsByField($table, $deletedField, '1', ' AND pid = ' . $id . $filterWhere, '', '', $limit, FALSE);
                if ($recordsToCheck) {
                    $this->checkRecordAccess($table, $recordsToCheck);
                }
            }
            // go into depth
            if ($allowDepth && $depth >= 1) {
                // check recursively for elements beneath this page
                $resPages = $GLOBALS['TYPO3_DB']->exec_SELECTquery('uid', 'pages', 'pid=' . $id, '', 'sorting');
                if ($resPages) {
                    while ($rowPages = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($resPages)) {
                        $this->setData($rowPages['uid'], $table, $depth - 1, $tcaCtrl, $filter);
                        // some records might have been added, check if we still have the limit for further queries
                        if ('' != $this->limit) {
                            $parts = \TYPO3\CMS\Core\Utility\GeneralUtility::trimExplode(',', $this->limit);
                            // abort loop if LIMIT 0,0
                            if ($parts[0] == 0 && $parts[1] == 0) {
                                break;
                            }
                        }
                    }
                    $GLOBALS['TYPO3_DB']->sql_free_result($resPages);
                }
            }
            $this->label[$table] = $tcaCtrl['label'];
            $this->title[$table] = $tcaCtrl['title'];
        }
    }

    protected function checkRecordAccess($table, array $rows) {
        foreach ($rows as $key => $row) {
            if (\TYPO3\CMS\Recycler\Utility\RecyclerUtility::checkAccess($table, $row)) {
                $this->setDeletedRows($table, $row);
            }
        }
    }

    protected function escapeValueForLike($value, $tableName) {
        return $GLOBALS['TYPO3_DB']->escapeStrForLike($GLOBALS['TYPO3_DB']->quoteStr($value, $tableName), $tableName);
    }

    /************************************************************
     * DELETE FUNCTIONS
     ************************************************************/
    public function deleteData($recordsArray) {
        $recordsArray = json_decode($recordsArray);
        if (is_array($recordsArray)) {
            $tce = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance('TYPO3\\CMS\\Core\\DataHandling\\DataHandler');
            $tce->start('', '');
            $tce->disableDeleteClause();
            foreach ($recordsArray as $key => $record) {
                $tce->deleteEl($record[0], $record[1], TRUE, TRUE);
            }
            return TRUE;
        }
        return FALSE;
    }

    /************************************************************
     * UNDELETE FUNCTIONS
     ************************************************************/
    public function undeleteData($recordsArray, $recursive = FALSE) {
        $result = FALSE;
        $depth = 999;
        $recordsArray = json_decode($recordsArray);
        if (is_array($recordsArray)) {
            $this->deletedRows = array();
            $cmd = array();
            foreach ($recordsArray as $key => $row) {
                $cmd[$row[0]][$row[1]]['undelete'] = 1;
                if ($row[0] == 'pages' && $recursive == TRUE) {
                    $this->loadData($row[1], '', $depth, '');
                    $childRecords = $this->getDeletedRows();
                    if (count($childRecords) > 0) {
                        foreach ($childRecords as $table => $childRows) {
                            foreach ($childRows as $childKey => $childRow) {
                                $cmd[$table][$childRow['uid']]['undelete'] = 1;
                            }
                        }
                    }
                }
            }
            if ($cmd) {
                $tce = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance('TYPO3\\CMS\\Core\\DataHandling\\DataHandler');
                $tce->start(array(), $cmd);
                $tce->process_cmdmap();
                $result = TRUE;
            }
        }
        return $result;
    }

    /************************************************************
     * SETTER FUNCTIONS
     ************************************************************/
    public function setDeletedRows($table, array $row) {
        $this->deletedRows[$table][] = $row;
    }

    /************************************************************
     * GETTER FUNCTIONS
     ************************************************************/
    public function getDeletedRows() {
        return $this->deletedRows;
    }

    public function getTable() {
        return $this->table;
    }

}