Server.php

Go to the documentation of this file.

<?php
/***************************************************************
*  Copyright notice
*
*  (c) 2010-2011 Workspaces Team (http://forge.typo3.org/projects/show/typo3v4-workspaces)
*  All rights reserved
*
*  This script is part of the TYPO3 project. The TYPO3 project 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.
*
*  The GNU General Public License can be found at
*  http://www.gnu.org/copyleft/gpl.html.
*  A copy is found in the textfile GPL.txt and important notices to the license
*  from the author is found in LICENSE.txt distributed with these scripts.
*
*
*  This script 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.
*
*  This copyright notice MUST APPEAR in all copies of the script!
***************************************************************/

/**
 * @author Workspaces Team (http://forge.typo3.org/projects/show/typo3v4-workspaces)
 * @package Workspaces
 * @subpackage ExtDirect
 */
class tx_Workspaces_ExtDirect_Server extends tx_Workspaces_ExtDirect_AbstractHandler {
    /**
     * Get List of workspace changes
     *
     * @param object $parameter
     * @return array $data
     */
    public function getWorkspaceInfos($parameter) {
            // To avoid too much work we use -1 to indicate that every page is relevant
        $pageId = $parameter->id > 0 ? $parameter->id : -1;

        $wslibObj = t3lib_div::makeInstance('tx_Workspaces_Service_Workspaces');
        $versions = $wslibObj->selectVersionsInWorkspace($this->getCurrentWorkspace(), 0, -99, $pageId, $parameter->depth);

        $workspacesService = t3lib_div::makeInstance('tx_Workspaces_Service_GridData');
        $data = $workspacesService->generateGridListFromVersions($versions, $parameter, $this->getCurrentWorkspace());
        return $data;
    }

    /**
     * Get List of available workspace actions
     *
     * @param object $parameter
     * @return array $data
     */
    public function getStageActions($parameter) {
        $currentWorkspace = $this->getCurrentWorkspace();
        $stages = array();
        if ($currentWorkspace != tx_Workspaces_Service_Workspaces::SELECT_ALL_WORKSPACES) {
            $stagesService = t3lib_div::makeInstance('Tx_Workspaces_Service_Stages');
            $stages = $stagesService->getStagesForWSUser();
        }

        $data = array(
            'total' => count($stages),
            'data' => $stages
        );
        return $data;
    }

    /**
     * Fetch futher information to current selected worspace record.
     *
     * @param object $parameter
     * @return array $data
     */
    public function getRowDetails($parameter) {
        global $TCA,$BE_USER;
        $diffReturnArray = array();
        $liveReturnArray = array();

        $t3lib_diff = t3lib_div::makeInstance('t3lib_diff');
        $stagesService = t3lib_div::makeInstance('Tx_Workspaces_Service_Stages');

        $liveRecord = t3lib_BEfunc::getRecord($parameter->table, $parameter->t3ver_oid);
        $versionRecord = t3lib_BEfunc::getRecord($parameter->table, $parameter->uid);
        $icon_Live = t3lib_iconWorks::mapRecordTypeToSpriteIconClass($parameter->table, $liveRecord);
        $icon_Workspace = t3lib_iconWorks::mapRecordTypeToSpriteIconClass($parameter->table, $versionRecord);
        $stagePosition = $stagesService->getPositionOfCurrentStage($parameter->stage);

        $fieldsOfRecords = array_keys($liveRecord);

        // get field list from TCA configuration, if available
        if ($TCA[$parameter->table]) {
            if ($TCA[$parameter->table]['interface']['showRecordFieldList']) {
                $fieldsOfRecords = $TCA[$parameter->table]['interface']['showRecordFieldList'];
                $fieldsOfRecords = t3lib_div::trimExplode(',',$fieldsOfRecords,1);
            }
        }

        foreach ($fieldsOfRecords as $fieldName) {
                // check for exclude fields
            if ($GLOBALS['BE_USER']->isAdmin() || ($TCA[$parameter->table]['columns'][$fieldName]['exclude'] == 0) || t3lib_div::inList($BE_USER->groupData['non_exclude_fields'],$parameter->table.':'.$fieldName)) {
                    // call diff class only if there is a difference
                if (strcmp($liveRecord[$fieldName],$versionRecord[$fieldName]) !== 0) {
                        // Select the human readable values before diff
                    $liveRecord[$fieldName] = t3lib_BEfunc::getProcessedValue($parameter->table,$fieldName,$liveRecord[$fieldName],0,1);
                    $versionRecord[$fieldName] = t3lib_BEfunc::getProcessedValue($parameter->table,$fieldName,$versionRecord[$fieldName],0,1);

                    $fieldTitle = $GLOBALS['LANG']->sL(t3lib_BEfunc::getItemLabel($parameter->table, $fieldName));

                    if ($TCA[$parameter->table]['columns'][$fieldName]['config']['type'] == 'group' && $TCA[$parameter->table]['columns'][$fieldName]['config']['internal_type'] == 'file') {
                        $versionThumb = t3lib_BEfunc::thumbCode($versionRecord, $parameter->table, $fieldName, '');
                        $liveThumb = t3lib_BEfunc::thumbCode($liveRecord, $parameter->table, $fieldName, '');

                        $diffReturnArray[] = array(
                            'label' => $fieldTitle,
                            'content' => $versionThumb
                        );
                        $liveReturnArray[] = array(
                            'label' => $fieldTitle,
                            'content' => $liveThumb
                        );
                    } else {
                        $diffReturnArray[] = array(
                            'label' => $fieldTitle,
                            'content' => $t3lib_diff->makeDiffDisplay($liveRecord[$fieldName], $versionRecord[$fieldName]) // call diff class to get diff
                        );
                        $liveReturnArray[] = array(
                            'label' => $fieldTitle,
                            'content' => $liveRecord[$fieldName]
                        );
                    }
                }
            }
        }

        $commentsForRecord = $this->getCommentsForRecord($parameter->uid, $parameter->table);

        return array(
            'total' => 1,
            'data' => array(
                array(
                    'diff' => $diffReturnArray,
                    'live_record' => $liveReturnArray,
                    'path_Live' => $parameter->path_Live,
                    'label_Stage' => $parameter->label_Stage,
                    'stage_position' => $stagePosition['position'],
                    'stage_count' => $stagePosition['count'],
                    'comments' => $commentsForRecord,
                    'icon_Live' => $icon_Live,
                    'icon_Workspace' => $icon_Workspace
                )
            )
        );
    }

    /**
     * Gets an array with all sys_log entries and their comments for the given record uid and table
     *
     * @param integer $uid uid of changed element to search for in log
     * @return string $table table name
     */
    public function getCommentsForRecord($uid, $table) {
        $stagesService = t3lib_div::makeInstance('Tx_Workspaces_Service_Stages');
        $sysLogReturnArray = array();

        $sysLogRows = $GLOBALS['TYPO3_DB']->exec_SELECTgetRows(
                'log_data,tstamp,userid',
                'sys_log',
                'action=6 and details_nr=30
                AND tablename='.$GLOBALS['TYPO3_DB']->fullQuoteStr($table,'sys_log').'
                AND recuid='.intval($uid),
                '',
                'tstamp DESC'
        );

        foreach($sysLogRows as $sysLogRow)  {
            $sysLogEntry = array();
            $data = unserialize($sysLogRow['log_data']);
            $beUserRecord = t3lib_BEfunc::getRecord('be_users', $sysLogRow['userid']);

            $sysLogEntry['stage_title'] = $stagesService->getStageTitle($data['stage']);
            $sysLogEntry['user_uid'] = $sysLogRow['userid'];
            $sysLogEntry['user_username'] = is_array($beUserRecord) ? $beUserRecord['username'] : '';
            $sysLogEntry['tstamp'] = t3lib_BEfunc::datetime($sysLogRow['tstamp']);
            $sysLogEntry['user_comment'] = $data['comment'];

            $sysLogReturnArray[] = $sysLogEntry;
        }

        return $sysLogReturnArray;
    }
}


if (defined('TYPO3_MODE') && isset($GLOBALS['TYPO3_CONF_VARS'][TYPO3_MODE]['XCLASS']['ext/workspaces/Classes/ExtDirect/Server.php'])) {
    include_once($GLOBALS['TYPO3_CONF_VARS'][TYPO3_MODE]['XCLASS']['ext/workspaces/Classes/ExtDirect/Server.php']);
}
?>