[TASK] Replace sprite icon for visibility with IconFactory
[Packages/TYPO3.CMS.git] / typo3 / sysext / feedit / Classes / FrontendEditPanel.php
1 <?php
2 namespace TYPO3\CMS\Feedit;
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\Backend\Utility\IconUtility;
19 use TYPO3\CMS\Backend\FrontendBackendUserAuthentication;
20 use TYPO3\CMS\Core\Database\DatabaseConnection;
21 use TYPO3\CMS\Core\Imaging\IconFactory;
22 use TYPO3\CMS\Core\Type\Bitmask\JsConfirmation;
23 use TYPO3\CMS\Core\Utility\GeneralUtility;
24 use TYPO3\CMS\Core\Utility\MathUtility;
25 use TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController;
26 use TYPO3\CMS\Frontend\View\AdminPanelView;
27
28 /**
29 * View class for the edit panels in frontend editing.
30 */
31 class FrontendEditPanel {
32
33 /**
34 * The Content Object Renderer
35 *
36 * @var \TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer
37 */
38 protected $cObj;
39
40 /**
41 * Property for accessing TypoScriptFrontendController centrally
42 *
43 * @var TypoScriptFrontendController
44 */
45 protected $frontendController;
46
47 /**
48 * Property for accessing DatabaseConnection centrally
49 *
50 * @var DatabaseConnection
51 */
52 protected $databaseConnection;
53
54 /**
55 * @var FrontendBackendUserAuthentication
56 */
57 protected $backendUser;
58
59 /**
60 * @var \TYPO3\CMS\Core\Imaging\IconFactory
61 */
62 protected $iconFactory;
63
64 /**
65 * Constructor for the edit panel
66 *
67 * @param DatabaseConnection $databaseConnection
68 * @param TypoScriptFrontendController $frontendController
69 * @param FrontendBackendUserAuthentication $backendUser
70 */
71 public function __construct(DatabaseConnection $databaseConnection = NULL, TypoScriptFrontendController $frontendController = NULL, FrontendBackendUserAuthentication $backendUser = NULL) {
72 $this->databaseConnection = $databaseConnection ?: $GLOBALS['TYPO3_DB'];
73 $this->frontendController = $frontendController ?: $GLOBALS['TSFE'];
74 $this->backendUser = $backendUser ?: $GLOBALS['BE_USER'];
75 $this->cObj = GeneralUtility::makeInstance(\TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::class);
76 $this->cObj->start(array());
77 $this->iconFactory = GeneralUtility::makeInstance(IconFactory::class);
78 }
79
80 /**
81 * Generates the "edit panels" which can be shown for a page or records on a page when the Admin Panel is enabled for a backend users surfing the frontend.
82 * With the "edit panel" the user will see buttons with links to editing, moving, hiding, deleting the element
83 * This function is used for the cObject EDITPANEL and the stdWrap property ".editPanel"
84 *
85 * @param string $content A content string containing the content related to the edit panel. For cObject "EDITPANEL" this is empty but not so for the stdWrap property. The edit panel is appended to this string and returned.
86 * @param array $conf TypoScript configuration properties for the editPanel
87 * @param string $currentRecord The "table:uid" of the record being shown. If empty string then $this->currentRecord is used. For new records (set by $conf['newRecordFromTable']) it's auto-generated to "[tablename]:NEW
88 * @param array $dataArr Alternative data array to use. Default is $this->data
89 * @param string $table
90 * @param array $allow
91 * @param int $newUID
92 * @param array $hiddenFields
93 * @return string The input content string with the editPanel appended. This function returns only an edit panel appended to the content string if a backend user is logged in (and has the correct permissions). Otherwise the content string is directly returned.
94 */
95 public function editPanel($content, array $conf, $currentRecord = '', array $dataArr = array(), $table = '', array $allow = array(), $newUID = 0, array $hiddenFields = array()) {
96 $hiddenFieldString = $command = '';
97
98 // Special content is about to be shown, so the cache must be disabled.
99 $this->frontendController->set_no_cache('Frontend edit panel is shown', TRUE);
100
101 $formName = 'TSFE_EDIT_FORM_' . substr($this->frontendController->uniqueHash(), 0, 4);
102 $formTag = '<form name="' . $formName . '" id ="' . $formName . '" action="' . htmlspecialchars(GeneralUtility::getIndpEnv('REQUEST_URI')) . '" method="post" enctype="multipart/form-data" onsubmit="return TBE_EDITOR.checkSubmit(1);">';
103 $sortField = $GLOBALS['TCA'][$table]['ctrl']['sortby'];
104 $labelField = $GLOBALS['TCA'][$table]['ctrl']['label'];
105 $hideField = $GLOBALS['TCA'][$table]['ctrl']['enablecolumns']['disabled'];
106
107 $panel = '';
108 if (isset($allow['toolbar']) && $this->backendUser->adminPanel instanceof AdminPanelView) {
109 $panel .= $this->backendUser->adminPanel->ext_makeToolBar();
110 }
111 if (isset($allow['edit'])) {
112 $icon = IconUtility::getSpriteIcon('actions-document-open', array('title' => $this->backendUser->extGetLL('p_editRecord')));
113 $panel .= $this->editPanelLinkWrap($icon, $formName, 'edit', $dataArr['_LOCALIZED_UID'] ? $table . ':' . $dataArr['_LOCALIZED_UID'] : $currentRecord);
114 }
115 // Hiding in workspaces because implementation is incomplete
116 if (isset($allow['move']) && $sortField && $this->backendUser->workspace === 0) {
117 $icon = IconUtility::getSpriteIcon('actions-move-up', array('title' => $this->backendUser->extGetLL('p_moveUp')));
118 $panel .= $this->editPanelLinkWrap($icon, $formName, 'up');
119 $icon = IconUtility::getSpriteIcon('actions-move-down', array('title' => $this->backendUser->extGetLL('p_moveDown')));
120 $panel .= $this->editPanelLinkWrap($icon, $formName, 'down');
121 }
122 // Hiding in workspaces because implementation is incomplete
123 // Hiding for localizations because it is unknown what should be the function in that case
124 if (isset($allow['hide']) && $hideField && $this->backendUser->workspace === 0 && !$dataArr['_LOCALIZED_UID']) {
125 if ($dataArr[$hideField]) {
126 $icon = $this->iconFactory->getIcon('actions-edit-unhide');
127 $panel .= $this->editPanelLinkWrap($icon, $formName, 'unhide');
128 } else {
129 $icon = $this->iconFactory->getIcon('actions-edit-hide');
130 $panel .= $this->editPanelLinkWrap($icon, $formName, 'hide', '', $this->backendUser->extGetLL('p_hideConfirm'));
131 }
132 }
133 if (isset($allow['new'])) {
134 if ($table === 'pages') {
135 $icon = IconUtility::getSpriteIcon('actions-page-new', array('title' => $this->backendUser->extGetLL('p_newSubpage')));
136 $panel .= $this->editPanelLinkWrap($icon, $formName, 'new', $currentRecord, '');
137 } else {
138 $icon = IconUtility::getSpriteIcon('actions-document-new', array('title' => $this->backendUser->extGetLL('p_newRecordAfter')));
139 $panel .= $this->editPanelLinkWrap($icon, $formName, 'new', $currentRecord, '', $newUID);
140 }
141 }
142 // Hiding in workspaces because implementation is incomplete
143 // Hiding for localizations because it is unknown what should be the function in that case
144 if (isset($allow['delete']) && $this->backendUser->workspace === 0 && !$dataArr['_LOCALIZED_UID']) {
145 $icon = IconUtility::getSpriteIcon('actions-edit-delete', array('title' => $this->backendUser->extGetLL('p_delete')));
146 $panel .= $this->editPanelLinkWrap($icon, $formName, 'delete', '', $this->backendUser->extGetLL('p_deleteConfirm'));
147 }
148 // Final
149 $labelTxt = $this->cObj->stdWrap($conf['label'], $conf['label.']);
150 foreach ((array)$hiddenFields as $name => $value) {
151 $hiddenFieldString .= '<input type="hidden" name="TSFE_EDIT[' . htmlspecialchars($name) . ']" value="' . htmlspecialchars($value) . '"/>' . LF;
152 }
153
154 $panel = '<!-- BE_USER Edit Panel: -->
155 ' . $formTag . $hiddenFieldString . '
156 <input type="hidden" name="TSFE_EDIT[cmd]" value="" />
157 <input type="hidden" name="TSFE_EDIT[record]" value="' . $currentRecord . '" />
158 <div class="typo3-editPanel">'
159 . $panel .
160 ($labelTxt ? '<div class="typo3-editPanel-label">' . sprintf($labelTxt, htmlspecialchars(GeneralUtility::fixed_lgd_cs($dataArr[$labelField], 50))) . '</div>' : '') . '
161 </div>
162 </form>';
163
164 // Wrap the panel
165 if ($conf['innerWrap']) {
166 $panel = $this->cObj->wrap($panel, $conf['innerWrap']);
167 }
168 if ($conf['innerWrap.']) {
169 $panel = $this->cObj->stdWrap($panel, $conf['innerWrap.']);
170 }
171
172 // Wrap the complete panel
173 if ($conf['outerWrap']) {
174 $panel = $this->cObj->wrap($panel, $conf['outerWrap']);
175 }
176 if ($conf['outerWrap.']) {
177 $panel = $this->cObj->stdWrap($panel, $conf['outerWrap.']);
178 }
179 if ($conf['printBeforeContent']) {
180 $finalOut = $panel . $content;
181 } else {
182 $finalOut = $content . $panel;
183 }
184
185 $hidden = $this->isDisabled($table, $dataArr) ? ' typo3-feedit-element-hidden' : '';
186 $outerWrapConfig = isset($conf['stdWrap.'])
187 ? $conf['stdWrap.']
188 : array('wrap' => '<div class="typo3-feedit-element' . $hidden . '">|</div>');
189 $finalOut = $this->cObj->stdWrap($finalOut, $outerWrapConfig);
190
191 return $finalOut;
192 }
193
194 /**
195 * Adds an edit icon to the content string. The edit icon links to EditDocumentController with proper parameters for editing the table/fields of the context.
196 * This implements TYPO3 context sensitive editing facilities. Only backend users will have access (if properly configured as well).
197 *
198 * @param string $content The content to which the edit icons should be appended
199 * @param string $params The parameters defining which table and fields to edit. Syntax is [tablename]:[fieldname],[fieldname],[fieldname],... OR [fieldname],[fieldname],[fieldname],... (basically "[tablename]:" is optional, default table is the one of the "current record" used in the function). The fieldlist is sent as "&columnsOnly=" parameter to EditDocumentController
200 * @param array $conf TypoScript properties for configuring the edit icons.
201 * @param string $currentRecord The "table:uid" of the record being shown. If empty string then $this->currentRecord is used. For new records (set by $conf['newRecordFromTable']) it's auto-generated to "[tablename]:NEW
202 * @param array $dataArr Alternative data array to use. Default is $this->data
203 * @param string $addUrlParamStr Additional URL parameters for the link pointing to EditDocumentController
204 * @param string $table
205 * @param int $editUid
206 * @param string $fieldList
207 * @return string The input content string, possibly with edit icons added (not necessarily in the end but just after the last string of normal content.
208 */
209 public function editIcons($content, $params, array $conf = array(), $currentRecord = '', array $dataArr = array(), $addUrlParamStr = '', $table, $editUid, $fieldList) {
210 // Special content is about to be shown, so the cache must be disabled.
211 $this->frontendController->set_no_cache('Display frontend edit icons', TRUE);
212 $iconTitle = $this->cObj->stdWrap($conf['iconTitle'], $conf['iconTitle.']);
213 $optionsArray = array(
214 'title' => htmlspecialchars($iconTitle, ENT_COMPAT, 'UTF-8', FALSE),
215 'class' => 'frontEndEditIcons',
216 'style' => $conf['styleAttribute'] ? htmlspecialchars($conf['styleAttribute']) : ''
217 );
218 $iconImg = $conf['iconImg'] ? $conf['iconImg'] : IconUtility::getSpriteIcon('actions-document-open', $optionsArray);
219 $nV = GeneralUtility::_GP('ADMCMD_view') ? 1 : 0;
220
221 $url = BackendUtility::getModuleUrl(
222 'record_edit',
223 array(
224 'edit[' . $table . '][' . $editUid . ']' => 'edit',
225 'columnsOnly' => $fieldList,
226 'noView' => $nV
227 )
228 ) . $addUrlParamStr;
229 $icon = $this->editPanelLinkWrap_doWrap($iconImg, $url);
230 if ($conf['beforeLastTag'] < 0) {
231 $content = $icon . $content;
232 } elseif ($conf['beforeLastTag'] > 0) {
233 $cBuf = rtrim($content);
234 $secureCount = 30;
235 while ($secureCount && substr($cBuf, -1) == '>' && substr($cBuf, -4) != '</a>') {
236 $cBuf = rtrim(preg_replace('/<[^<]*>$/', '', $cBuf));
237 $secureCount--;
238 }
239 $content = strlen($cBuf) && $secureCount ? substr($content, 0, strlen($cBuf)) . $icon . substr($content, strlen($cBuf)) : ($content = $icon . $content);
240 } else {
241 $content .= $icon;
242 }
243 return $content;
244 }
245
246 /**
247 * Helper function for editPanel() which wraps icons in the panel in a link with the action of the panel.
248 * The links are for some of them not simple hyperlinks but onclick-actions which submits a little form which the panel is wrapped in.
249 *
250 * @param string $string The string to wrap in a link, typ. and image used as button in the edit panel.
251 * @param string $formName The name of the form wrapping the edit panel.
252 * @param string $cmd The command of the link. There is a predefined list available: edit, new, up, down etc.
253 * @param string $currentRecord The "table:uid" of the record being processed by the panel.
254 * @param string $confirm Text string with confirmation message; If set a confirm box will be displayed before carrying out the action (if Yes is pressed)
255 * @param int|string $nPid "New pid" - for new records
256 * @return string A <a> tag wrapped string.
257 */
258 protected function editPanelLinkWrap($string, $formName, $cmd, $currentRecord = '', $confirm = '', $nPid = '') {
259 $nV = GeneralUtility::_GP('ADMCMD_view') ? 1 : 0;
260 if ($cmd == 'edit') {
261 $rParts = explode(':', $currentRecord);
262 $out = $this->editPanelLinkWrap_doWrap($string, BackendUtility::getModuleUrl('record_edit', array('edit[' . $rParts[0] . '][' . $rParts[1] . ']' => 'edit', 'noView=' . $nV)), $currentRecord);
263 } elseif ($cmd == 'new') {
264 $rParts = explode(':', $currentRecord);
265 if ($rParts[0] == 'pages') {
266 $out = $this->editPanelLinkWrap_doWrap($string, BackendUtility::getModuleUrl('db_new', ['id' => $rParts[1], 'pagesOnly' => 1]), $currentRecord);
267 } else {
268 if (!(int)$nPid) {
269 $nPid = MathUtility::canBeInterpretedAsInteger($rParts[1]) ? -$rParts[1] : $this->frontendController->id;
270 }
271 $out = $this->editPanelLinkWrap_doWrap($string, BackendUtility::getModuleUrl('record_edit', array('edit[' . $rParts[0] . '][' . $nPid . ']' => 'new', 'noView' => $nV)), $currentRecord);
272 }
273 } else {
274 if ($confirm && $this->backendUser->jsConfirmation(JsConfirmation::FE_EDIT)) {
275 // Gets htmlspecialchared later
276 $cf1 = 'if (confirm(' . GeneralUtility::quoteJSvalue($confirm, TRUE) . ')) {';
277 $cf2 = '}';
278 } else {
279 $cf1 = ($cf2 = '');
280 }
281 $out = '<a href="#" onclick="' . htmlspecialchars(($cf1 . 'document.' . $formName . '[\'TSFE_EDIT[cmd]\'].value=\'' . $cmd . '\'; document.' . $formName . '.submit();' . $cf2 . ' return false;')) . '">' . $string . '</a>';
282 }
283 return $out;
284 }
285
286 /**
287 * Creates a link to a script (eg. EditDocumentController or NewRecordController) which either opens in the current frame OR in a pop-up window.
288 *
289 * @param string $string The string to wrap in a link, typ. and image used as button in the edit panel.
290 * @param string $url The URL of the link. Should be absolute if supposed to work with <base> path set.
291 * @return string A <a> tag wrapped string.
292 * @see editPanelLinkWrap()
293 */
294 protected function editPanelLinkWrap_doWrap($string, $url) {
295 $onclick = 'vHWin=window.open(' . GeneralUtility::quoteJSvalue($url . '&returnUrl=sysext/backend/Resources/Private/Templates/Close.html') . ',\'FEquickEditWindow\',\'width=690,height=500,status=0,menubar=0,scrollbars=1,resizable=1\');vHWin.focus();return false;';
296 return '<a href="#" onclick="' . htmlspecialchars($onclick) . '" class="frontEndEditIconLinks">' . $string . '</a>';
297 }
298
299 /**
300 * Returns TRUE if the input table/row would be hidden in the frontend, according to the current time and simulate user group
301 *
302 * @param string $table The table name
303 * @param array $row The data record
304 * @return bool
305 */
306 protected function isDisabled($table, array $row) {
307 $status = FALSE;
308 if (
309 $GLOBALS['TCA'][$table]['ctrl']['enablecolumns']['disabled'] &&
310 $row[$GLOBALS['TCA'][$table]['ctrl']['enablecolumns']['disabled']] ||
311 $GLOBALS['TCA'][$table]['ctrl']['enablecolumns']['fe_group'] &&
312 $this->frontendController->simUserGroup &&
313 $row[$GLOBALS['TCA'][$table]['ctrl']['enablecolumns']['fe_group']] == $this->frontendController->simUserGroup ||
314 $GLOBALS['TCA'][$table]['ctrl']['enablecolumns']['starttime'] &&
315 $row[$GLOBALS['TCA'][$table]['ctrl']['enablecolumns']['starttime']] > $GLOBALS['EXEC_TIME'] ||
316 $GLOBALS['TCA'][$table]['ctrl']['enablecolumns']['endtime'] &&
317 $row[$GLOBALS['TCA'][$table]['ctrl']['enablecolumns']['endtime']] &&
318 $row[$GLOBALS['TCA'][$table]['ctrl']['enablecolumns']['endtime']] < $GLOBALS['EXEC_TIME']
319 ) {
320 $status = TRUE;
321 }
322
323 return $status;
324 }
325
326 }