Link.php 48.2 KB
Newer Older
Carsten  Rose's avatar
Carsten Rose committed
1
<?php
2
3
4
/***************************************************************
 *  Copyright notice
 *
Carsten  Rose's avatar
Carsten Rose committed
5
 *  (c) 2010 Glowbase GmbH
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
 *
 *  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.
 *
 *  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!
 ***************************************************************/

namespace qfq;

//use qfq;

require_once(__DIR__ . '/Define.php');
29
30
require_once(__DIR__ . '/../store/Store.php');
require_once(__DIR__ . '/../store/Sip.php');
31
require_once(__DIR__ . '/../exceptions/UserReportException.php');
32
require_once(__DIR__ . '/../helper/KeyValueStringParser.php');
33
require_once(__DIR__ . '/../helper/Token.php');
34
require_once(__DIR__ . '/Thumbnail.php');
35
36
37
38
39
40
41
42
43
44
45
46

/*
 * u:url
 * m:mailto
 * p:page
 * 
 * t:text
 * a:AltText
 * o:ToolTip
 * 
 * r:render   
 * g:target
47
 * c:class  [n|i|e|<class>]
48
49
 * q:question  <text>
 * e:encryption 0|1
50
 * b:bootstrap button
51
52
53
54
55
56
57
58
59
60
61
 * 
 * E:edit
 * N:new
 * D:delete
 * H:Help
 * I:information
 * M:Magnifier
 * B:bullet
 * P:picture       [file]
 * C:checkbox    [name]
 * R:right 
Carsten  Rose's avatar
Carsten Rose committed
62
 * s:sip
63
 *
64
65
66
67
 * A:    A:[u:p:m]
 * G:    G:[N|..]
 */

68
69
70
71
72

const NAME_URL = 'url';
const NAME_MAIL = 'mail';
const NAME_PAGE = 'page';
const NAME_TEXT = 'text';
Carsten  Rose's avatar
Carsten Rose committed
73
74
75
const NAME_DOWNLOAD = DOWNLOAD_EXPORT_FILENAME;
const NAME_DOWNLOAD_ELEMENTS = 'downloadElements';  // array with element sources
const NAME_DOWNLOAD_MODE = 'mode';
76
const NAME_BOOTSTRAP_BUTTON = 'bootstrapButton';
77
78
const NAME_ALT_TEXT = 'altText';
const NAME_TOOL_TIP = 'toolTip';
79
const NAME_TOOL_TIP_JS = 'toolTipJs';
80
81
const NAME_IMAGE = 'image';
const NAME_IMAGE_TITLE = 'imageTitle';
82
83
const NAME_GLYPH = 'glyph';
const NAME_GLYPH_TITLE = 'glyphTitle';
84
85
86
87
88
89
90
const NAME_DELETE = 'delete';
const NAME_RENDER = 'render';
const NAME_TARGET = 'target';
const NAME_LINK_CLASS = 'linkClass';
const NAME_LINK_CLASS_DEFAULT = 'linkClassDefault';
const NAME_QUESTION = 'question';
const NAME_ENCRYPTION = 'encryption';
Carsten  Rose's avatar
Carsten Rose committed
91
const NAME_SIP = 'sip';
92
const NAME_URL_PARAM = 'param';
93
const NAME_RIGHT = 'picturePositionRight';
94
const NAME_ACTION_DELETE = 'actionDelete';
Carsten  Rose's avatar
Carsten Rose committed
95
const NAME_EXTRA_CONTENT_WRAP = 'extraContentWrap';
Carsten  Rose's avatar
Carsten Rose committed
96
const NAME_FILE = 'file';
97
98
const NAME_THUMBNAIL = 'thumbnail';
const NAME_THUMBNAIL_DIMENSION = 'thumbnailDimension';
99
100
101
102
103
104
105
106

const FINAL_HREF = 'finalHref';
const FINAL_ANCHOR = 'finalAnchor';
const FINAL_CONTENT = 'finalContent';
const FINAL_SYMBOL = 'finalSymbol';
const FINAL_TOOL_TIP = 'finalToolTip';
const FINAL_CLASS = 'finalClass';
const FINAL_QUESTION = 'finalQuestion';
107
const FINAL_THUMBNAIL = 'finalThumbnail';
108

109
110
111
const LINK_ANCHOR = 'linkAnchor';
const LINK_PICTURE = 'linkPicture';

112
113
const NO_CLASS = 'no_class';

Carsten  Rose's avatar
Carsten Rose committed
114
115
const DEFAULT_BULLET_COLOR = 'green';
const DEFAULT_CHECK_COLOR = 'green';
116
const DEFAULT_RENDER_MODE = '0';
Carsten  Rose's avatar
Carsten Rose committed
117
118
const DEFAULT_QUESTION_TEXT = 'Please confirm';
const DEFAULT_QUESTION_LEVEL = 'info';
119
const DEFAULT_ACTION_DELETE = 'r';
Carsten  Rose's avatar
Carsten Rose committed
120

Carsten  Rose's avatar
Carsten Rose committed
121
122
123
124
const QUESTION_INDEX_TEXT = 0;
const QUESTION_INDEX_LEVEL = 1;
const QUESTION_INDEX_BUTTON_OK = 2;
const QUESTION_INDEX_BUTTON_FALSE = 3;
125
126
const QUESTION_INDEX_TIMEOUT = 4;
const QUESTION_INDEX_FLAG_MODAL = 5;
Carsten  Rose's avatar
Carsten Rose committed
127

128
129
130
131
/**
 * Class Link
 * @package qfq
 */
132
133
class Link {

Carsten  Rose's avatar
Carsten Rose committed
134
    /**
135
     * @var Sip
Carsten  Rose's avatar
Carsten Rose committed
136
137
138
     */
    private $sip = null;

139
140
141
142
143
    /**
     * @var Store
     */
    private $store = null;

144
145
146
147
148
    /**
     * @var Thumbnail
     */
    private $thumbnail = null;

Carsten  Rose's avatar
Carsten Rose committed
149
    private $phpUnit;
150
    private $renderControl = array();
151
//    private $linkClassSelector = array(TOKEN_CLASS_INTERNAL => "internal ", TOKEN_CLASS_EXTERNAL => "external ");
152
153
    private $cssLinkClassInternal = '';
    private $cssLinkClassExternal = '';
Carsten  Rose's avatar
Carsten Rose committed
154
    private $ttContentUid = '';
155

156
    private $callTable = [
Carsten  Rose's avatar
Carsten Rose committed
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
        TOKEN_URL => 'buildUrl',
        TOKEN_MAIL => 'buildMail',
        TOKEN_PAGE => 'buildPage',
        TOKEN_DOWNLOAD => 'buildDownload',
        TOKEN_TOOL_TIP => 'buildToolTip',
        TOKEN_PICTURE => 'buildPicture',
        TOKEN_BULLET => 'buildBullet',
        TOKEN_CHECK => 'buildCheck',
        TOKEN_DELETE => 'buildDeleteIcon',
        TOKEN_ACTION_DELETE => 'buildActionDelete',
        TOKEN_EDIT => 'buildEdit',
        TOKEN_HELP => 'buildHelp',
        TOKEN_INFO => 'buildInfo',
        TOKEN_NEW => 'buildNew',
        TOKEN_SHOW => 'buildShow',
        TOKEN_FILE => 'buildFile',
173
        TOKEN_FILE_DEPRECATED => 'buildFile',
Carsten  Rose's avatar
Carsten Rose committed
174
        TOKEN_GLYPH => 'buildGlyph',
175
        TOKEN_BOOTSTRAP_BUTTON => 'buildBootstrapButton',
176
177
    ];

178
    private $tableVarName = [
Carsten  Rose's avatar
Carsten Rose committed
179
180
181
182
183
184
185
        TOKEN_URL => NAME_URL,
        TOKEN_MAIL => NAME_MAIL,
        TOKEN_PAGE => NAME_PAGE,
        TOKEN_DOWNLOAD => NAME_DOWNLOAD,
        TOKEN_DOWNLOAD_MODE => NAME_DOWNLOAD_MODE,
        TOKEN_TEXT => NAME_TEXT,
        TOKEN_ALT_TEXT => NAME_ALT_TEXT,
186
        TOKEN_BOOTSTRAP_BUTTON => NAME_BOOTSTRAP_BUTTON,
Carsten  Rose's avatar
Carsten Rose committed
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
        TOKEN_TOOL_TIP => NAME_TOOL_TIP,
        TOKEN_PICTURE => NAME_IMAGE,
        TOKEN_BULLET => NAME_IMAGE,
        TOKEN_CHECK => NAME_IMAGE,
        TOKEN_DELETE => NAME_IMAGE,
        TOKEN_EDIT => NAME_IMAGE,
        TOKEN_HELP => NAME_IMAGE,
        TOKEN_INFO => NAME_IMAGE,
        TOKEN_NEW => NAME_IMAGE,
        TOKEN_SHOW => NAME_IMAGE,
        TOKEN_GLYPH => NAME_IMAGE,
        TOKEN_RENDER => NAME_RENDER,
        TOKEN_TARGET => NAME_TARGET,
        TOKEN_CLASS => NAME_LINK_CLASS,
        TOKEN_QUESTION => NAME_QUESTION,
        TOKEN_ENCRYPTION => NAME_ENCRYPTION,
        TOKEN_SIP => NAME_SIP,
        TOKEN_URL_PARAM => NAME_URL_PARAM,
        TOKEN_RIGHT => NAME_RIGHT,
        TOKEN_ACTION_DELETE => NAME_ACTION_DELETE,
        TOKEN_FILE => NAME_FILE,
208
        TOKEN_FILE_DEPRECATED => NAME_FILE,
209
210
        TOKEN_THUMBNAIL => NAME_THUMBNAIL,
        TOKEN_THUMBNAIL_DIMENSION => NAME_THUMBNAIL_DIMENSION,
211
212
    ];

Carsten  Rose's avatar
Carsten Rose committed
213
    // Used to find double definitions.
214
    private $tokenMapping = [
Carsten  Rose's avatar
Carsten Rose committed
215
216
217
        TOKEN_URL => LINK_ANCHOR,
        TOKEN_MAIL => LINK_ANCHOR,
        TOKEN_PAGE => LINK_ANCHOR,
Carsten  Rose's avatar
Carsten Rose committed
218
        TOKEN_DOWNLOAD => LINK_ANCHOR,
Carsten  Rose's avatar
Carsten Rose committed
219

220
        TOKEN_PICTURE => LINK_PICTURE,
Carsten  Rose's avatar
Carsten Rose committed
221
222
223
224
225
226
227
228
229
        TOKEN_BULLET => LINK_PICTURE,
        TOKEN_CHECK => LINK_PICTURE,
        TOKEN_DELETE => LINK_PICTURE,
        TOKEN_EDIT => LINK_PICTURE,
        TOKEN_HELP => LINK_PICTURE,
        TOKEN_INFO => LINK_PICTURE,
        TOKEN_NEW => LINK_PICTURE,
        TOKEN_SHOW => LINK_PICTURE,
        TOKEN_GLYPH => LINK_PICTURE,
230
    ];
231

232
233
234
    /**
     * __construct
     *
235
     * @param Sip $sip
236
     * @param bool $phpUnit
237
     */
238
    public function __construct(Sip $sip, $phpUnit = false) {
Carsten  Rose's avatar
Carsten Rose committed
239
        $this->phpUnit = $phpUnit;
240
241
242
243
244

        if ($phpUnit) {
            $_SERVER['REQUEST_URI'] = 'localhost';
        }

Carsten  Rose's avatar
Carsten Rose committed
245
        $this->sip = $sip;
Carsten  Rose's avatar
Carsten Rose committed
246
        $this->store = Store::getInstance('', $phpUnit);
247
248
        $this->cssLinkClassInternal = $this->store->getVar(SYSTEM_CSS_LINK_CLASS_INTERNAL, STORE_SYSTEM);
        $this->cssLinkClassExternal = $this->store->getVar(SYSTEM_CSS_LINK_CLASS_EXTERNAL, STORE_SYSTEM);
Carsten  Rose's avatar
Carsten Rose committed
249
        $this->ttContentUid = $this->store->getVar(TYPO3_TT_CONTENT_UID, STORE_TYPO3);
250
251
252
253

        /*
         * mode:
         * 0: no output
254
255
         * 1: <span title='...'>text</span>   (no href)
         * 2: <span title='...'>url</span>    (no href)
256
257
         * 3: <a href=url>url</a>
         * 4: <a href=url>Text</a>
258
259
         * 5: text
         * 6: url
260
         *
Carsten  Rose's avatar
Carsten Rose committed
261
         *  r=render mode, u=url, t:text and/or image.
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
         *
         *                  [r][u][t] = mode
         */

        $this->renderControl[0][0][0] = 0;
        $this->renderControl[0][0][1] = 0;
        $this->renderControl[0][1][0] = 3;
        $this->renderControl[0][1][1] = 4;

        $this->renderControl[1][0][0] = 0;
        $this->renderControl[1][0][1] = 1;
        $this->renderControl[1][1][0] = 3;
        $this->renderControl[1][1][1] = 4;

        $this->renderControl[2][0][0] = 0;
        $this->renderControl[2][0][1] = 0;
        $this->renderControl[2][1][0] = 0;
        $this->renderControl[2][1][1] = 4;

        $this->renderControl[3][0][0] = 0;
        $this->renderControl[3][0][1] = 1;
        $this->renderControl[3][1][0] = 2;
        $this->renderControl[3][1][1] = 1;

        $this->renderControl[4][0][0] = 0;
        $this->renderControl[4][0][1] = 1;
        $this->renderControl[4][1][0] = 2;
        $this->renderControl[4][1][1] = 2;

        $this->renderControl[5][0][0] = 0;
        $this->renderControl[5][0][1] = 0;
        $this->renderControl[5][1][0] = 0;
        $this->renderControl[5][1][1] = 0;
295

296
297
298
299
300
        $this->renderControl[6][0][0] = 0;
        $this->renderControl[6][0][1] = 5;
        $this->renderControl[6][1][0] = 0;
        $this->renderControl[6][1][1] = 5;

301
302
303
304
        $this->renderControl[7][0][0] = 0;
        $this->renderControl[7][0][1] = 0;
        $this->renderControl[7][1][0] = 6;
        $this->renderControl[7][1][1] = 6;
305

306
    }
307

308
    /**
309
310
     * In render mode 3,4,5 there is no '<a href ...>'. Nevertheless, tooltip and BS Button should be displaye.
     * Do this by applying a '<span>' attribute around the text.
311
     *
312
313
314
315
     * @param array $vars
     * @param       $keyName
     *
     * @return string
316
     */
317
318
319
320
    private function wrapLinkTextOnly(array $vars, $keyName) {

        $text = $vars[$keyName];
        if ($vars[NAME_BOOTSTRAP_BUTTON] == '' && $vars[FINAL_TOOL_TIP] == '') {
321
322
323
            return $text;
        }

324
325
326
327
328
329
330
        $attributes = Support::doAttribute('title', $vars[FINAL_TOOL_TIP]);

        if ($vars[NAME_BOOTSTRAP_BUTTON] != '') {
            $attributes .= Support::doAttribute('class', [$vars[NAME_BOOTSTRAP_BUTTON], 'disabled']);
        }

        return Support::wrapTag("<span $attributes>", $text);
331
332
333

    }

334
335
336
    /**
     * Build the whole link
     *
337
     * @param string $str Qualifier with params. 'report'-syntax. F.e.:  A:u:www.example.com|G:P:home.gif|t:Home"
Carsten  Rose's avatar
Carsten Rose committed
338
339
340
     *
     * @return string The complete HTML encoded Link like <a href='http://example.com' class='external'><img
     *                src='iconf.gif' title='help text'>Description</a>
341
     * @throws UserReportException
342
     */
Carsten  Rose's avatar
Carsten Rose committed
343
    public function renderLink($str) {
344

345
        $tokenGiven = array();
346
        $link = "";
347

348
        if (empty($str)) {
349
            return '';
350
        }
351

352
        $vars = $this->fillParameter($str, $tokenGiven);
Carsten  Rose's avatar
Carsten Rose committed
353
        $vars = $this->processParameter($vars, $tokenGiven);
354
        $mode = $this->getModeRender($vars);
355

Carsten  Rose's avatar
Carsten Rose committed
356
357
358
359
        if (isset($tokenGiven[TOKEN_DOWNLOAD]) && $tokenGiven[TOKEN_DOWNLOAD] === true) {
            $this->store->setVar(SYSTEM_DOWNLOAD_POPUP, DOWNLOAD_POPUP_REQUEST, STORE_SYSTEM);
        }

360
        // 0-6 URL, plain email
361
        // 10-14 encrypted email
362
        // 20-24 delete / ajax
363
364
365
366
367
368
369
370
371
        switch ($mode) {
            // 0: No Output
            case '0':
            case '10':
            case '20':
                break;

            // 1: 'text'
            case '1':
372
//                $link = $vars[FINAL_CONTENT];
373
                $link = $this->wrapLinkTextOnly($vars, FINAL_CONTENT);
374
375
                break;
            case '11':
376
//                $link = $vars[FINAL_CONTENT];
377
                $link = $this->wrapLinkTextOnly($vars, FINAL_CONTENT);
378
//                $link = $this->encryptMailtoJS($vars, false);
379
380
381
382
                break;

            // 2: 'url'
            case '2':
383
//                $link = $vars[FINAL_HREF];
384
                $link = $this->wrapLinkTextOnly($vars, FINAL_HREF);
385
386
                break;
            case '12':
387
//                $link = $vars[FINAL_HREF];
388
                $link = $this->wrapLinkTextOnly($vars, FINAL_HREF);
389
//                $link = $this->encryptMailtoJS($vars, false);
390
391
                break;

392
            // 3: <a href=url ...>url</a>
393
            case '3':
Carsten  Rose's avatar
Carsten Rose committed
394
//                $link = $htmlUrl . $vars[NAME_URL] . '</a>' . $vars[NAME_TOOL_TIP_JS][1];
395
                $link = Support::wrapTag($vars[FINAL_ANCHOR], $vars[FINAL_HREF]);
396
397
                break;
            case '13':
398
399
400
                $link = Support::wrapTag($vars[FINAL_ANCHOR], $vars[FINAL_HREF]);
//                $vars[NAME_TEXT] = $vars[NAME_MAIL];
//                $link = $this->encryptMailtoJS($vars, true);
401
402
                break;

403
            // 4: <a href=url ...>Text</a>
404
            case '4':
405
                $link = Support::wrapTag($vars[FINAL_ANCHOR], $vars[FINAL_CONTENT]);
406
407
                break;
            case '14':
408
409
                $link = Support::wrapTag($vars[FINAL_ANCHOR], $vars[FINAL_CONTENT]);
//                $link = $this->encryptMailtoJS($vars, true);
410
                break;
411

412
413
414
415
            case '21':
            case '22':
            case '23':
            case '24':
416
            //TODO: Alter Code, umstellen auf JS Client von RO. Vorlage koennte 'Delete' in Subrecord sein.
Carsten  Rose's avatar
Carsten Rose committed
417
            $link = "<a href=\"javascript: void(0);\" onClick=\"var del = new FR.Delete({recordId:'',sip:'',forward:'" .
418
                $vars[NAME_PAGE] . "'});\" " . $vars[NAME_LINK_CLASS] . ">" . $vars[NAME_TEXT] . "</a>";
419
            break;
420
421
422

            // 5: plain text, no <span> around
            case '5':
423
                $link = $vars[NAME_TEXT];
424
425
426
427
428
                break;
            case '15':
            case '25':
                throw new UserReportException ("Mode not implemented. internal render mode=$mode", ERROR_UNKNOWN_MODE);

429
            // 6: plain url, no <span> around
430
431
432
433
434
435
            case '6':
                $link = $vars[FINAL_HREF];
                break;
            case '16':
            case '26':
                throw new UserReportException ("Mode not implemented. internal render mode=$mode", ERROR_UNKNOWN_MODE);
436
437
438
439
440
                break;


            default:
                throw new UserReportException ("Mode not implemented. internal render mode=$mode", ERROR_UNKNOWN_MODE);
441
442
        }

443
444
445
        return $link;
    }

446
    /**
447
     * Order $param. Parameter with priority are hardcoded at the moment.
448
449
     *
     * @param array $param
Carsten  Rose's avatar
Carsten Rose committed
450
     *
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
     * @return array
     */
    private function paramPriority(array $param) {
        $prio = array();
        $regular = array();

        foreach ($param as $value) {
            switch (substr($value, 0, 1)) {
                case TOKEN_DOWNLOAD:
                    $prio[] = $value;
                    break;
                default:
                    $regular[] = $value;
                    break;
            }
        }

        return array_merge($prio, $regular);
    }
470

471
    /**
472
473
     * Iterate over all given token.
     *
474
     * @param string $str
Carsten  Rose's avatar
Carsten Rose committed
475
     * @param array $tokenGiven
Carsten  Rose's avatar
Carsten Rose committed
476
     *
477
     * @return array
478
     * @throws UserReportException
479
     */
480
    private function fillParameter($str, array &$tokenGiven) {
481

Carsten  Rose's avatar
Carsten Rose committed
482
        // Define all possible vars: no more isset().
483
484
        $vars = $this->initVars();
        $flagArray = array();
485

Carsten  Rose's avatar
Carsten Rose committed
486
        // str="u:http://www.example.com|c:i|t:Hello World|q:Do you really want to delete the record 25:warn:yes:no"
Carsten  Rose's avatar
Carsten Rose committed
487
        $param = explode(PARAM_DELIMITER, $str);
488

489
490
        $param = $this->paramPriority($param);

Carsten  Rose's avatar
Carsten Rose committed
491
        // Parse all parameter, fill variables.
492
        foreach ($param as $item) {
493

494
            // Skip empty entries
495
496
497
            if ($item === '') {
                continue;
            }
498

499
500
501
502
            // u:www.example.com
            $arr = explode(":", $item, 2);
            $key = isset($arr[0]) ? $arr[0] : '';
            $value = isset($arr[1]) ? $arr[1] : '';
503

504
            // Bookkeeping defined parameter.
505
506
507
508
509
510
            if (isset($tokenGiven[$key])) {
                throw new UserReportException ("Multiple definitions for key '$key'", ERROR_MULTIPLE_DEFINITION);
            }
            $tokenGiven[$key] = true;

            if (!isset($this->tableVarName[$key])) {
511
                throw new UserReportException ("Unknown link qualifier: '$key' - do you forget the one character qualifier?", ERROR_UNKNOWN_LINK_QUALIFIER);
512
            }
Carsten  Rose's avatar
Carsten Rose committed
513

514
515
            $keyName = $this->tableVarName[$key]; // convert token to name

516
517
518
519
520
            if ($key == TOKEN_PAGE && $value == '') {
                $value = $this->store->getVar(TYPO3_PAGE_ID, STORE_TYPO3); // If no pageid|pagealias is defined, take current page
            }
            $value = Token::checkForEmptyValue($key, $value);

521
            $value = $this->checkValue($key, $value);
522

523
            // Store value
524
            if (isset($tokenGiven[TOKEN_DOWNLOAD]) && ($key == TOKEN_PAGE || $key == TOKEN_URL || $key == TOKEN_URL_PARAM || $key == TOKEN_FILE || $key == TOKEN_FILE_DEPRECATED)) {
Carsten  Rose's avatar
Carsten Rose committed
525
526
527
528
529
530

                $vars[NAME_DOWNLOAD_ELEMENTS][] = $key . ':' . $value;

                unset($tokenGiven[$key]); // Skip Bookkeeping for TOKEN_URL_PARAM | TOKEN_FILE | TOKEN_URL.
                continue;
            } else {
531
532
533
534
                // TOKEN_GLYPH should not treated as an regular image. Same applies to the other Glyph symbols, but those don't have a value, and therefore do not fill $vars['image'].
                if ($key != TOKEN_GLYPH) {
                    $vars[$keyName] = $value;
                }
Carsten  Rose's avatar
Carsten Rose committed
535
536
            }

537
538
539
540
541
            // Check for double anchor or picture definition
            if (isset($this->tokenMapping[$key])) {
                $type = $this->tokenMapping[$key];

                if (isset($flagArray[$type])) {
Carsten  Rose's avatar
Carsten Rose committed
542
                    throw new UserReportException ("Multiple definitions of url/mail/page/download or picture", ERROR_MULTIPLE_DEFINITION);
543
544
545
546
547
548
549
                }
                $flagArray[$type] = true;

//                if ($type === LINK_PICTURE) {
//                    $build = 'build' . strtoupper($keyName[0]) . substr($keyName, 1);
//                    $this->$build($vars, $value);
//                }
550
551
            }

552
553
554
555
            if (isset($this->callTable[$key])) {
                $build = $this->callTable[$key];
                $vars = $this->$build($vars, $value);
            }
556
557
        }

558
        // Final Checks
Carsten  Rose's avatar
Carsten Rose committed
559
        $this->checkParam($tokenGiven, $vars);
560

561
562
563
        return $vars;
    }

564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
    /**
     * Cleans and make existing the standard vars used every time to render a link.
     *
     * @return array
     */
    private function initVars() {

        return [
            NAME_MAIL => '',
            NAME_URL => '',
            NAME_PAGE => '',

            NAME_TEXT => '',
            NAME_ALT_TEXT => '',
            NAME_BOOTSTRAP_BUTTON => '',
            NAME_IMAGE => '',
            NAME_IMAGE_TITLE => '',
            NAME_GLYPH => '',
            NAME_GLYPH_TITLE => '',
            NAME_QUESTION => '',
            NAME_TARGET => '',
            NAME_TOOL_TIP => '',
            NAME_TOOL_TIP_JS => '',
            NAME_URL_PARAM => '',
            NAME_EXTRA_CONTENT_WRAP => '',
            NAME_DOWNLOAD_MODE => '',
            NAME_DOWNLOAD_ELEMENTS => array(),

            NAME_RENDER => '0',
            NAME_RIGHT => 'l',
            NAME_SIP => '0',
            NAME_ENCRYPTION => '0',
            NAME_DELETE => '',

            NAME_LINK_CLASS => '', // class name
            NAME_LINK_CLASS_DEFAULT => '', // Depending of 'as page' or 'as url'. Only used if class is not explizit set.

            NAME_ACTION_DELETE => '',

            FINAL_HREF => '',
            FINAL_CONTENT => '',
            FINAL_SYMBOL => '',
            FINAL_TOOL_TIP => '',
            FINAL_CLASS => '',
            FINAL_QUESTION => '',
609
            FINAL_THUMBNAIL => '',
610
611
612
        ];

    }
613
614

    /**
615
616
     * Validate value for token
     *
617
618
     * @param $key
     * @param $value
Carsten  Rose's avatar
Carsten Rose committed
619
     *
620
621
622
623
624
625
626
627
     * @return mixed
     * @throws UserReportException
     */
    private function checkValue($key, $value) {
        switch ($key) {
            case TOKEN_ENCRYPTION:
            case TOKEN_SIP:
                if ($value !== '0' && $value !== '1') {
628
                    throw new UserReportException ("Invalid value for token '$key': '$value''", ERROR_INVALID_VALUE);
629
630
                }
                break;
631
632
633
634
635
636
637
638
639
640
            case TOKEN_ACTION_DELETE:
                switch ($value) {
                    case TOKEN_ACTION_DELETE_AJAX:
                    case TOKEN_ACTION_DELETE_REPORT:
                    case TOKEN_ACTION_DELETE_CLOSE:
                        break;
                    default:
                        throw new UserReportException ("Invalid value for token '$key': '$value''", ERROR_INVALID_VALUE);
                }
                break;
641
642
643
644
645
            case TOKEN_BOOTSTRAP_BUTTON:
                if ($value == '1') {
                    $value = 'btn-default';
                }
                break;
646
647
648
649
650
651
            default:
        }

        return $value;
    }

652
653
654
655
    /**
     * Check for double definition.
     *
     * @param array $tokenGiven
Carsten  Rose's avatar
Carsten Rose committed
656
     *
657
658
     * @throws UserReportException
     */
Carsten  Rose's avatar
Carsten Rose committed
659
    private function checkParam(array $tokenGiven, array $vars) {
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
        $countLinkAnchor = 0;
        $countLinkPicture = 0;

        foreach ($tokenGiven as $token => $value) {
            if (isset($this->tokenMapping[$token])) {
                switch ($this->tokenMapping[$token]) {
                    case LINK_ANCHOR:
                        $countLinkAnchor++;
                        break;
                    case LINK_PICTURE:
                        $countLinkPicture++;
                        break;
                    default:
                        break;
                }
            }
        }

        if ($countLinkAnchor > 1) {
679
680
            throw new UserReportException ("Multiple URL / PAGE and MAILTO definition", ERROR_MULTIPLE_URL_PAGE_MAILTO_DEFINITION);
        }
681

682
683
684
685
686
687
        if ($countLinkPicture > 1) {
            throw new UserReportException ("Multiple definitions for token picture/bullet/check/edit...delete'" . TOKEN_PAGE . "'", ERROR_MULTIPLE_DEFINITION);
        }

        if (isset($tokenGiven[TOKEN_MAIL]) && isset($tokenGiven[TOKEN_TARGET])) {
            throw new UserReportException ("Token Mail and Target at the same time not possible'" . TOKEN_PAGE . "'", ERROR_MULTIPLE_DEFINITION);
688
        }
Carsten  Rose's avatar
Carsten Rose committed
689
690
691
692

        if (isset($tokenGiven[TOKEN_DOWNLOAD]) && count($vars[NAME_DOWNLOAD_ELEMENTS]) == 0) {
            throw new UserReportException ("Missing element sources for download", ERROR_MISSING_REQUIRED_PARAMETER);
        }
693
    }
694
695

    /**
696
     * Compute final link parameter.
697
     *
Carsten  Rose's avatar
Carsten Rose committed
698
     * @param array $vars
Carsten  Rose's avatar
Carsten Rose committed
699
     * @param array $tokenGiven
Carsten  Rose's avatar
Carsten Rose committed
700
     *
701
702
     * @return string
     * @throws UserReportException
703
     */
Carsten  Rose's avatar
Carsten Rose committed
704
    private function processParameter(array $vars, array $tokenGiven) {
705

Carsten  Rose's avatar
Carsten Rose committed
706
        $vars[FINAL_HREF] = $this->doHref($vars, $tokenGiven); // must be called before doToolTip()
707
708
709
        $vars[FINAL_TOOL_TIP] = $this->doToolTip($vars);
        $vars[FINAL_CLASS] = $this->doCssClass($vars);
        $vars[FINAL_SYMBOL] = $this->doSymbol($vars);
710
        $vars[FINAL_THUMBNAIL] = $this->doThumbnail($vars);
Carsten  Rose's avatar
Carsten Rose committed
711
712
        $vars[FINAL_CONTENT] = $this->doContent($vars); // must be called after doSymbol()
        $vars[FINAL_QUESTION] = $this->doQuestion($vars);
713
        $vars[FINAL_ANCHOR] = $this->doAnchor($vars);
714

715
        return $vars;
716
    }
717

Carsten  Rose's avatar
Carsten Rose committed
718
719
    /**
     * @param array $vars
Carsten  Rose's avatar
Carsten Rose committed
720
     *
Carsten  Rose's avatar
Carsten Rose committed
721
722
723
724
725
726
727
728
729
730
731
     * @return string
     * @throws UserFormException
     */
    private function getDownloadModeNCheck(array $vars) {

        $cnt = count($vars[NAME_DOWNLOAD_ELEMENTS]);
        $mode = $vars[NAME_DOWNLOAD_MODE];

        // Determine default.
        if ($mode == '') {
            if ($cnt == 1) {
732
                $mode = (substr($vars[NAME_DOWNLOAD_ELEMENTS][0], 0, 1) == TOKEN_FILE_DEPRECATED) ? DOWNLOAD_MODE_FILE : DOWNLOAD_MODE_PDF;
Carsten  Rose's avatar
Carsten Rose committed
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
            } else {
                $mode = DOWNLOAD_MODE_PDF;
            }
        }

        // Do some checks.
        switch ($mode) {
            case DOWNLOAD_MODE_PDF:
            case DOWNLOAD_MODE_ZIP:
                break;
            case DOWNLOAD_MODE_FILE:
            case DOWNLOAD_MODE_EXCEL:
                if ($cnt > 1) {
                    throw new UserFormException("With 'downloadMode' = 'file' or 'excle', only one element source is allowed.", ERROR_DOWNLOAD_UNEXPECTED_NUMBER_OF_SOURCES);
                }
                break;
            default:
                throw new UserFormException("Unknown mode: $mode", ERROR_UNKNOWN_MODE);
                break;

        }

        return $mode;
    }

758
    /**
759
     * Concat final HREF string
760
     *
761
     * @param array $vars
Carsten  Rose's avatar
Carsten Rose committed
762
     * @param array $tokenGiven
Carsten  Rose's avatar
Carsten Rose committed
763
     *
764
     * @return string
Carsten  Rose's avatar
Carsten Rose committed
765
     * @throws CodeException
766
     * @throws UserReportException
767
     */
Carsten  Rose's avatar
Carsten Rose committed
768
    private function doHref(array &$vars, array $tokenGiven) {
769
        $urlNParam = '';
770

Carsten  Rose's avatar
Carsten Rose committed
771
772
773
774
775
776
777
778
779
780
781
782
783

        if (isset($tokenGiven[TOKEN_DOWNLOAD])) {
            // Message in download popup.
            $altText = ($vars[NAME_ALT_TEXT] == '') ? 'Please wait' : addslashes($vars[NAME_ALT_TEXT]);
            $vars[NAME_EXTRA_CONTENT_WRAP] = str_replace(DOWNLOAD_POPUP_REPLACE_TEXT, $altText, $vars[NAME_EXTRA_CONTENT_WRAP]);
            $vars[NAME_EXTRA_CONTENT_WRAP] = str_replace(DOWNLOAD_POPUP_REPLACE_TITLE, 'Download: ' . addslashes($vars[NAME_DOWNLOAD]), $vars[NAME_EXTRA_CONTENT_WRAP]);

            $tmpUrlParam[DOWNLOAD_MODE] = $this->getDownloadModeNCheck($vars);
            $tmpUrlParam[DOWNLOAD_EXPORT_FILENAME] = $vars[NAME_DOWNLOAD];
            $tmpUrlParam[SIP_DOWNLOAD_PARAMETER] = base64_encode(implode(PARAM_DELIMITER, $vars[NAME_DOWNLOAD_ELEMENTS]));
            $vars[NAME_URL_PARAM] = KeyValueStringParser::unparse($tmpUrlParam, '=', '&');
        }

784
785
786
787
        if ($vars[NAME_ACTION_DELETE] !== '') {
            $vars[NAME_URL_PARAM] = $this->adjustDeleteParameter($vars[NAME_ACTION_DELETE], $vars[NAME_URL_PARAM]);
        }

788
        if ($vars[NAME_MAIL] === '') {
789
790
791
792
793

            if (substr($vars[NAME_URL], 0, 1) === '?') {
                $vars[NAME_URL] = INDEX_PHP . $vars[NAME_URL];
            }

794
795
            // Either NAME_URL is empty or NAME_PAGE is empty
            $urlNParam = Support::concatUrlParam($vars[NAME_URL] . $vars[NAME_PAGE], $vars[NAME_URL_PARAM]);
796

Carsten  Rose's avatar
Carsten Rose committed
797
            if ($vars[NAME_SIP] === "1") {
798
799
                $paramArray = $this->sip->queryStringToSip($urlNParam, RETURN_ARRAY);
                $urlNParam = $paramArray['_url'];
800

801
                if (Support::findInSet(SYSTEM_SHOW_DEBUG_INFO_YES, $this->store->getVar(SYSTEM_SHOW_DEBUG_INFO, STORE_SYSTEM))) {
Carsten  Rose's avatar
Carsten Rose committed
802
                    $vars[NAME_TOOL_TIP] .= PHP_EOL . PHP_EOL . $this->sip->debugSip($paramArray);
803
804
                }
            }
805
806
            // Link: MAILTO
        } else {
807
            // If there is no encryption: handle the mailto as an ordinary URL
808
            if ($vars[NAME_ENCRYPTION] === '1') {
809
                throw new UserReportException ("Oops, sorry: encrypted mail not implemented ...", ERROR_NOT_IMPLEMENTED);
810
811
            } else {
                $urlNParam = "mailto:" . $vars[NAME_MAIL];
812
813
814
            }
        }

815
816
        return $urlNParam;
    }
817

818

819
820
821
    /**
     * @param $tokenActionDelete
     * @param $nameUrlParam
Carsten  Rose's avatar
Carsten Rose committed
822
     *
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
     * @return string
     * @throws UserReportException
     */
    private function adjustDeleteParameter($tokenActionDelete, $nameUrlParam) {

        $kvp = new KeyValueStringParser();

        // Split in: [p => 'r=100&table=note&..', 'D' => ''... ],
//        $param = $kvp->parse($nameUrlParam, ':', '|');

//        Support::setIfNotSet($param, TOKEN_URL_PARAM);

        switch ($tokenActionDelete) {
            case TOKEN_ACTION_DELETE_AJAX:
                // TODO: Implement for AJAX (subrecord)
                throw new UserReportException ("Not implemented!", ERROR_NOT_IMPLEMENTED);
                break;
            case TOKEN_ACTION_DELETE_REPORT:
                $nameUrlParam .= '&' . SIP_MODE_ANSWER . '=' . MODE_HTML;
                $nameUrlParam .= '&' . SIP_TARGET_URL . '=' . $_SERVER['REQUEST_URI'];
                break;
            case TOKEN_ACTION_DELETE_CLOSE:
                // TODO: Implement for Form (primary Record wird geloescht)
                throw new UserReportException ("Not implemented!", ERROR_NOT_IMPLEMENTED);
                break;
            default:
                throw new UserReportException ("Invalid value for token '" . TOKEN_ACTION_DELETE . "': '$tokenActionDelete''", ERROR_INVALID_VALUE);
        }

        return $nameUrlParam;
    }

855
856
857
858
    /**
     * Return $vars[NAME_TOOL_TIP]. If $vars[NAME_TOOL_TIP] is empty, set $vars[NAME_GLYPH_TITLE] as tooltip.
     *
     * @param array $vars
Carsten  Rose's avatar
Carsten Rose committed
859
     *
860
861
862
     * @return mixed
     */
    private function doToolTip(array $vars) {
863

864
865
866
        // Set default tooltip
        if ($vars[NAME_TOOL_TIP] == '') {
            $vars[NAME_TOOL_TIP] = $vars[NAME_GLYPH_TITLE];
Carsten  Rose's avatar
Carsten Rose committed
867
        }
868

869
        return $vars[NAME_TOOL_TIP];
870
    }
871

872
    /**
873
     * Parse CSS Class Settings
874
     *
875
     * @param array $vars
Carsten  Rose's avatar
Carsten Rose committed
876
     *
877
     * @return    string
878
     */
879
    private function doCssClass(array $vars) {
880

881
882
//        $class = ($vars[NAME_LINK_CLASS] === '') ? $vars[NAME_LINK_CLASS_DEFAULT] : $vars[NAME_LINK_CLASS];
        $class = $vars[NAME_LINK_CLASS];
Carsten  Rose's avatar
Carsten Rose committed
883

884
885
886
887
        switch ($class) {
            case TOKEN_CLASS_NONE:
                $class = '';
                break;
888
889
890
891
892
// #5302
//            case TOKEN_CLASS_INTERNAL:
//            case TOKEN_CLASS_EXTERNAL:
//                $class = $this->linkClassSelector[$vars[NAME_LINK_CLASS]] . ' ';
//                break;
893
894
895
            default:
                break;
        }
896

897
898
899
        if ($class === NO_CLASS) {
            $class = '';
        }
900

901
        //TODO: Old way to detect if BS Button should be rendered - should be replaced by 'b:'
902
        if ($vars[NAME_GLYPH] !== '' && $vars[NAME_EXTRA_CONTENT_WRAP] == '' && $vars[NAME_BOOTSTRAP_BUTTON] == '') {
903
            $class = 'btn btn-default ' . $class;
904
        }
905

906
        return implode(' ', [$vars[NAME_BOOTSTRAP_BUTTON], $class]);
907
    }
908

909
910
911
    /**
     * Create Image HTML Tag
     *
912
     * @param array $vars
Carsten  Rose's avatar
Carsten Rose committed
913
     *
914
     * @return string
915
     */
916
    private function doSymbol(array $vars) {
917
        $tags = '';
918
        $html = '';
919
920

        // Build Image
921
        if ($vars[NAME_IMAGE] !== '') {
922
923
            $tags .= Support::doAttribute('alt', $vars[NAME_ALT_TEXT]);
            $tags .= Support::doAttribute('src', $vars[NAME_IMAGE]);
924
            $tags .= Support::doAttribute('title', $vars[FINAL_TOOL_TIP] === '' ? $vars[NAME_IMAGE_TITLE] : $vars[FINAL_TOOL_TIP]);
925
            $html .= '<img ' . $tags . '>';
926
927
        }

928
929
930
931
932
933
        if ($vars[NAME_GLYPH] !== '') {
            $tags = Support::doAttribute('class', 'glyphicon ' . $vars[NAME_GLYPH]);
            $html .= Support::wrapTag('<span ' . $tags . '>', '', false);
        }

        return $html;
934
    }
935

936
    /**
937
938
     * Concat Text, Image, Glyph and/or Thumbnail.
     * Depending of $vars[NAME_RIGHT_PICTURE_POSITION], swap the position,
939
940
     *
     * @param array $vars
Carsten  Rose's avatar
Carsten Rose committed
941
     *
942
943
944
     * @return string
     */
    private function doContent(array $vars) {
945
        $arr = array();
946

947
948
        $order = ($vars[NAME_RIGHT] === "l") ? [FINAL_SYMBOL, FINAL_THUMBNAIL, NAME_TEXT] : [NAME_TEXT, FINAL_THUMBNAIL, FINAL_SYMBOL];
        foreach ($order as $key) {
949
            if (isset($vars[$key]) && $vars[$key] != '') { // empty() is wrong here, cause '0' would be recognized as empty.
950
                $arr[] = $vars[$key];
951
952
            }
        }
953
954
        $content = implode(' ', $arr);

Carsten  Rose's avatar
Carsten Rose committed
955
956
957
958
        if ($vars[NAME_EXTRA_CONTENT_WRAP] != '') {
            $content = Support::wrapTag($vars[NAME_EXTRA_CONTENT_WRAP], $content);
        }

959
960
961
        return $content;
    }

Carsten  Rose's avatar
Carsten Rose committed
962
963
964
965
966
    /**
     * Build 'alert' JS. $vars['question'] = '<text>:<color>:<button ok>:<button fail>'
     * Return JS Code to place in '<a>' tag. Be carefull: function creates a uniqe 'id' tag.
     *
     * @param array $vars
Carsten  Rose's avatar
Carsten Rose committed
967
     *
Carsten  Rose's avatar
Carsten Rose committed
968
969
970
971
972
973
974
975
976
     * @return string
     */
    private function doQuestion(array $vars) {

        if ($vars[NAME_QUESTION] === '') {
            return '';
        }

        $arr = OnArray::explodeWithoutEscaped(':', $vars[NAME_QUESTION]);
977
        $arr = array_merge($arr, ['', '', '', '', '', '']);
Carsten  Rose's avatar
Carsten Rose committed
978
979
980
981
982
983
984
985

        $id = ($this->phpUnit === true) ? '12345' : uniqid('a_');
        $content = Support::doAttribute('id', $id);

        $text = $arr[QUESTION_INDEX_TEXT] === '' ? DEFAULT_QUESTION_TEXT : $arr[QUESTION_INDEX_TEXT];
        $level = ($arr[QUESTION_INDEX_LEVEL] === '') ? DEFAULT_QUESTION_LEVEL : $arr[QUESTION_INDEX_LEVEL];
        $ok = ($arr[QUESTION_INDEX_BUTTON_OK] === '') ? 'Ok' : $arr[QUESTION_INDEX_BUTTON_OK];
        $cancel = ($arr[QUESTION_INDEX_BUTTON_FALSE] === '') ? 'Cancel' : $arr[QUESTION_INDEX_BUTTON_FALSE];
986
987
988
        $timeout = ($arr[QUESTION_INDEX_TIMEOUT] === '') ? '0' : $arr[QUESTION_INDEX_TIMEOUT] * 1000;
        $flagModalStatus = ($arr[QUESTION_INDEX_FLAG_MODAL] === '') ? '1' : $arr[QUESTION_INDEX_FLAG_MODAL];
        $flagModal = ($flagModalStatus === "1") ? 'true' : 'false';
Carsten  Rose's avatar
Carsten Rose committed
989
990

        $js = <<<EOF
991
var alert = new QfqNS.Alert({ message: '$text', type: '$level', modal: $flagModal, timeout: $timeout, buttons: [
Carsten  Rose's avatar
Carsten Rose committed
992
993
    { label: '$ok', eventName: 'ok' },
    { label: '$cancel',eventName: 'cancel'}
994
] } );
Carsten  Rose's avatar
Carsten Rose committed
995
996
997
998
999
1000
alert.on('alert.ok', function() {
  window.location = $('#$id').attr('href');
});

alert.show();
return false;