[TASK] Revamp EXT:recycler
[Packages/TYPO3.CMS.git] / typo3 / sysext / recycler / Classes / Utility / RecyclerUtility.php
1 <?php
2 namespace TYPO3\CMS\Recycler\Utility;
3
4 /*
5 * This file is part of the TYPO3 CMS project.
6 *
7 * It is free software; you can redistribute it and/or modify it under
8 * the terms of the GNU General Public License, either version 2
9 * of the License, or any later version.
10 *
11 * For the full copyright and license information, please read the
12 * LICENSE.txt file that was distributed with this source code.
13 *
14 * The TYPO3 project - inspiring people to share!
15 */
16
17 use TYPO3\CMS\Backend\Utility\BackendUtility;
18 use TYPO3\CMS\Core\Utility\GeneralUtility;
19
20 /**
21 * Helper class for the 'recycler' extension.
22 *
23 * @author Julian Kleinhans <typo3@kj187.de>
24 */
25 class RecyclerUtility {
26
27 /************************************************************
28 * USER ACCESS
29 *
30 *
31 ************************************************************/
32 /**
33 * Checks the page access rights (Code for access check mostly taken from alt_doc.php)
34 * as well as the table access rights of the user.
35 *
36 * @param string $table The table to check access for
37 * @param string $row Record array
38 * @return bool Returns TRUE is the user has access, or FALSE if not
39 */
40 static public function checkAccess($table, $row) {
41 $backendUser = static::getBackendUser();
42
43 // Checking if the user has permissions? (Only working as a precaution, because the final permission check is always down in TCE. But it's good to notify the user on beforehand...)
44 // First, resetting flags.
45 $hasAccess = FALSE;
46 $calcPRec = $row;
47 BackendUtility::fixVersioningPid($table, $calcPRec);
48 if (is_array($calcPRec)) {
49 if ($table === 'pages') {
50 // If pages:
51 $calculatedPermissions = $backendUser->calcPerms($calcPRec);
52 $hasAccess = $calculatedPermissions & 2 ? TRUE : FALSE;
53 } else {
54 $calculatedPermissions = $backendUser->calcPerms(BackendUtility::getRecord('pages', $calcPRec['pid']));
55 // Fetching pid-record first.
56 $hasAccess = $calculatedPermissions & 16 ? TRUE : FALSE;
57 }
58 // Check internals regarding access:
59 if ($hasAccess) {
60 $hasAccess = $backendUser->recordEditAccessInternals($table, $calcPRec);
61 }
62 }
63 if (!$backendUser->check('tables_modify', $table)) {
64 $hasAccess = FALSE;
65 }
66 return $hasAccess;
67 }
68
69 /**
70 * Returns the path (visually) of a page $uid, fx. "/First page/Second page/Another subpage"
71 * Each part of the path will be limited to $titleLimit characters
72 * Deleted pages are filtered out.
73 *
74 * @param int $uid Page uid for which to create record path
75 * @param string $clause is additional where clauses, eg.
76 * @param int $titleLimit Title limit
77 * @param int $fullTitleLimit Title limit of Full title (typ. set to 1000 or so)
78 * @return mixed Path of record (string) OR array with short/long title if $fullTitleLimit is set.
79 */
80 static public function getRecordPath($uid, $clause = '', $titleLimit = 1000, $fullTitleLimit = 0) {
81 $uid = (int)$uid;
82 $output = ($fullOutput = '/');
83 if ($uid === 0) {
84 return $output;
85 }
86 $databaseConnection = static::getDatabaseConnection();
87 $clause = trim($clause) !== '' ? ' AND ' . $clause : '';
88 $loopCheck = 100;
89 while ($loopCheck > 0) {
90 $loopCheck--;
91 $res = $databaseConnection->exec_SELECTquery('uid,pid,title,deleted,t3ver_oid,t3ver_wsid', 'pages', 'uid=' . $uid . $clause);
92 if ($res !== FALSE) {
93 $row = $databaseConnection->sql_fetch_assoc($res);
94 $databaseConnection->sql_free_result($res);
95 BackendUtility::workspaceOL('pages', $row);
96 if (is_array($row)) {
97 BackendUtility::fixVersioningPid('pages', $row);
98 $uid = (int)$row['pid'];
99 $output = '/' . htmlspecialchars(GeneralUtility::fixed_lgd_cs($row['title'], $titleLimit)) . $output;
100 if ($row['deleted']) {
101 $output = '<span class="text-danger">' . $output . '</span>';
102 }
103 if ($fullTitleLimit) {
104 $fullOutput = '/' . htmlspecialchars(GeneralUtility::fixed_lgd_cs($row['title'], $fullTitleLimit)) . $fullOutput;
105 }
106 } else {
107 break;
108 }
109 } else {
110 break;
111 }
112 }
113 if ($fullTitleLimit) {
114 return array($output, $fullOutput);
115 } else {
116 return $output;
117 }
118 }
119
120 /**
121 * Gets the name of the field with the information whether a record is deleted.
122 *
123 * @param string $tableName Name of the table to get the deleted field for
124 * @return string Name of the field with the information whether a record is deleted
125 */
126 static public function getDeletedField($tableName) {
127 $TCA = self::getTableTCA($tableName);
128 if ($TCA && isset($TCA['ctrl']['delete']) && $TCA['ctrl']['delete']) {
129 return $TCA['ctrl']['delete'];
130 }
131 return '';
132 }
133
134 /**
135 * Gets the TCA of the table used in the current context.
136 *
137 * @param string $tableName Name of the table to get TCA for
138 * @return array|FALSE TCA of the table used in the current context
139 */
140 static public function getTableTCA($tableName) {
141 $TCA = FALSE;
142 if (isset($GLOBALS['TCA'][$tableName])) {
143 $TCA = $GLOBALS['TCA'][$tableName];
144 }
145 return $TCA;
146 }
147
148 /**
149 * Gets the current backend charset.
150 *
151 * @return string The current backend charset
152 */
153 static public function getCurrentCharset() {
154 $lang = static::getLanguageService();
155 return $lang->csConvObj->parse_charset($lang->charSet);
156 }
157
158 /**
159 * Determines whether the current charset is not UTF-8
160 *
161 * @return bool Whether the current charset is not UTF-8
162 */
163 static public function isNotUtf8Charset() {
164 return self::getCurrentCharset() !== 'utf-8';
165 }
166
167 /**
168 * Gets an UTF-8 encoded string (only if the current charset is not UTF-8!).
169 *
170 * @param string $string String to be converted to UTF-8 if required
171 * @return string UTF-8 encoded string
172 */
173 static public function getUtf8String($string) {
174 if (self::isNotUtf8Charset()) {
175 $string = static::getLanguageService()->csConvObj->utf8_encode($string, self::getCurrentCharset());
176 }
177 return $string;
178 }
179
180 /**
181 * Returns an instance of DatabaseConnection
182 *
183 * @return \TYPO3\CMS\Core\Database\DatabaseConnection
184 */
185 static protected function getDatabaseConnection() {
186 return $GLOBALS['TYPO3_DB'];
187 }
188
189 /**
190 * Returns the BackendUser
191 *
192 * @return \TYPO3\CMS\Core\Authentication\BackendUserAuthentication
193 */
194 static protected function getBackendUser() {
195 return $GLOBALS['BE_USER'];
196 }
197
198 /**
199 * Returns an instance of LanguageService
200 *
201 * @return \TYPO3\CMS\Lang\LanguageService
202 */
203 static protected function getLanguageService() {
204 return $GLOBALS['LANG'];
205 }
206
207 /**
208 * Returns the modifyable tables of the current user
209 */
210 static public function getModifyableTables() {
211 if ((bool)$GLOBALS['BE_USER']->user['admin']) {
212 $tables = array_keys($GLOBALS['TCA']);
213 } else {
214 $tables = explode(',', $GLOBALS['BE_USER']->groupData['tables_modify']);
215 }
216 return $tables;
217 }
218
219 }