Link.php 48.3 KB
Newer Older
Carsten  Rose's avatar
Carsten Rose committed
1
<?php
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
/***************************************************************
 *  Copyright notice
 *
 *  (c) 2010 Glowbase GmbH <support@glowbase.com>
 *  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.
 *
 *  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');
30
31
require_once(__DIR__ . '/../store/Store.php');
require_once(__DIR__ . '/../store/Sip.php');
32
require_once(__DIR__ . '/../exceptions/UserReportException.php');
33
require_once(__DIR__ . '/../helper/KeyValueStringParser.php');
34
require_once(__DIR__ . '/../helper/Token.php');
35
require_once(__DIR__ . '/Thumbnail.php');
36
37
38
39
40
41
42
43
44
45
46
47

/*
 * u:url
 * m:mailto
 * p:page
 * 
 * t:text
 * a:AltText
 * o:ToolTip
 * 
 * r:render   
 * g:target
48
 * c:class  [n|i|e|<class>]
49
50
 * q:question  <text>
 * e:encryption 0|1
51
 * b:bootstrap button
52
53
54
55
56
57
58
59
60
61
62
 * 
 * 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
63
 * s:sip
64
 *
65
66
67
68
 * A:    A:[u:p:m]
 * G:    G:[N|..]
 */

69
70
71
72
73

const NAME_URL = 'url';
const NAME_MAIL = 'mail';
const NAME_PAGE = 'page';
const NAME_TEXT = 'text';
Carsten  Rose's avatar
Carsten Rose committed
74
75
76
const NAME_DOWNLOAD = DOWNLOAD_EXPORT_FILENAME;
const NAME_DOWNLOAD_ELEMENTS = 'downloadElements';  // array with element sources
const NAME_DOWNLOAD_MODE = 'mode';
77
const NAME_BOOTSTRAP_BUTTON = 'bootstrapButton';
78
79
const NAME_ALT_TEXT = 'altText';
const NAME_TOOL_TIP = 'toolTip';
80
const NAME_TOOL_TIP_JS = 'toolTipJs';
81
82
const NAME_IMAGE = 'image';
const NAME_IMAGE_TITLE = 'imageTitle';
83
84
const NAME_GLYPH = 'glyph';
const NAME_GLYPH_TITLE = 'glyphTitle';
85
86
87
88
89
90
91
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
92
const NAME_SIP = 'sip';
93
const NAME_URL_PARAM = 'param';
94
const NAME_RIGHT = 'picturePositionRight';
95
const NAME_ACTION_DELETE = 'actionDelete';
Carsten  Rose's avatar
Carsten Rose committed
96
const NAME_EXTRA_CONTENT_WRAP = 'extraContentWrap';
Carsten  Rose's avatar
Carsten Rose committed
97
const NAME_FILE = 'file';
98
99
const NAME_THUMBNAIL = 'thumbnail';
const NAME_THUMBNAIL_DIMENSION = 'thumbnailDimension';
100
101
102
103
104
105
106
107

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';
108
const FINAL_THUMBNAIL = 'finalThumbnail';
109

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

113
114
const NO_CLASS = 'no_class';

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

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

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

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

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

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

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

157
    private $callTable = [
Carsten  Rose's avatar
Carsten Rose committed
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
        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',
174
        TOKEN_FILE_DEPRECATED => 'buildFile',
Carsten  Rose's avatar
Carsten Rose committed
175
        TOKEN_GLYPH => 'buildGlyph',
176
        TOKEN_BOOTSTRAP_BUTTON => 'buildBootstrapButton',
177
178
    ];

179
    private $tableVarName = [
Carsten  Rose's avatar
Carsten Rose committed
180
181
182
183
184
185
186
        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,
187
        TOKEN_BOOTSTRAP_BUTTON => NAME_BOOTSTRAP_BUTTON,
Carsten  Rose's avatar
Carsten Rose committed
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
        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,
209
        TOKEN_FILE_DEPRECATED => NAME_FILE,
210
211
        TOKEN_THUMBNAIL => NAME_THUMBNAIL,
        TOKEN_THUMBNAIL_DIMENSION => NAME_THUMBNAIL_DIMENSION,
212
213
    ];

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

221
        TOKEN_PICTURE => LINK_PICTURE,
Carsten  Rose's avatar
Carsten Rose committed
222
223
224
225
226
227
228
229
230
        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,
231
    ];
232

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

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

Carsten  Rose's avatar
Carsten Rose committed
246
        $this->sip = $sip;
Carsten  Rose's avatar
Carsten Rose committed
247
        $this->store = Store::getInstance('', $phpUnit);
248
249
        $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
250
        $this->ttContentUid = $this->store->getVar(TYPO3_TT_CONTENT_UID, STORE_TYPO3);
251
252
253
254

        /*
         * mode:
         * 0: no output
255
256
         * 1: <span title='...'>text</span>   (no href)
         * 2: <span title='...'>url</span>    (no href)
257
258
         * 3: <a href=url>url</a>
         * 4: <a href=url>Text</a>
259
260
         * 5: text
         * 6: url
261
         *
Carsten  Rose's avatar
Carsten Rose committed
262
         *  r=render mode, u=url, t:text and/or image.
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
295
         *
         *                  [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;
296

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

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

307
    }
308

309
    /**
310
311
     * 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.
312
     *
313
314
315
316
     * @param array $vars
     * @param       $keyName
     *
     * @return string
317
     */
318
319
320
321
    private function wrapLinkTextOnly(array $vars, $keyName) {

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

325
326
327
328
329
330
331
        $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);
332
333
334

    }

335
336
337
    /**
     * Build the whole link
     *
338
     * @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
339
340
341
     *
     * @return string The complete HTML encoded Link like <a href='http://example.com' class='external'><img
     *                src='iconf.gif' title='help text'>Description</a>
342
     * @throws UserReportException
343
     */
Carsten  Rose's avatar
Carsten Rose committed
344
    public function renderLink($str) {
345

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

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

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

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

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

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

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

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

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

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

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

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


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

444
445
446
        return $link;
    }

447
    /**
448
     * Order $param. Parameter with priority are hardcoded at the moment.
449
450
     *
     * @param array $param
Carsten  Rose's avatar
Carsten Rose committed
451
     *
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
     * @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);
    }
471

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

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

Carsten  Rose's avatar
Carsten Rose committed
487
        // 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
488
        $param = explode(PARAM_DELIMITER, $str);
489

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

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

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

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

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

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

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

517
518
519
520
521
            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);

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

524
            // Store value
525
            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
526
527
528
529
530
531

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

                unset($tokenGiven[$key]); // Skip Bookkeeping for TOKEN_URL_PARAM | TOKEN_FILE | TOKEN_URL.
                continue;
            } else {
532
533
534
535
                // 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
536
537
            }

538
539
540
541
542
            // 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
543
                    throw new UserReportException ("Multiple definitions of url/mail/page/download or picture", ERROR_MULTIPLE_DEFINITION);
544
545
546
547
548
549
550
                }
                $flagArray[$type] = true;

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

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

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

562
563
564
        return $vars;
    }

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
609
    /**
     * 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 => '',
610
            FINAL_THUMBNAIL => '',
611
612
613
        ];

    }
614
615

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

        return $value;
    }

653
654
655
656
    /**
     * Check for double definition.
     *
     * @param array $tokenGiven
Carsten  Rose's avatar
Carsten Rose committed
657
     *
658
659
     * @throws UserReportException
     */
Carsten  Rose's avatar
Carsten Rose committed
660
    private function checkParam(array $tokenGiven, array $vars) {
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
        $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) {
680
681
            throw new UserReportException ("Multiple URL / PAGE and MAILTO definition", ERROR_MULTIPLE_URL_PAGE_MAILTO_DEFINITION);
        }
682

683
684
685
686
687
688
        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);
689
        }
Carsten  Rose's avatar
Carsten Rose committed
690
691
692
693

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

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

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

716
        return $vars;
717
    }
718

Carsten  Rose's avatar
Carsten Rose committed
719
720
    /**
     * @param array $vars
Carsten  Rose's avatar
Carsten Rose committed
721
     *
Carsten  Rose's avatar
Carsten Rose committed
722
723
724
725
726
727
728
729
730
731
732
     * @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) {
733
                $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
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
            } 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;
    }

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

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

        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, '=', '&');
        }

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

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

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

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

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

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

816
817
        return $urlNParam;
    }
818

819

820
821
822
    /**
     * @param $tokenActionDelete
     * @param $nameUrlParam
Carsten  Rose's avatar
Carsten Rose committed
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
855
     * @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;
    }

856
857
858
859
    /**
     * 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
860
     *
861
862
863
     * @return mixed
     */
    private function doToolTip(array $vars) {
864

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

870
        return $vars[NAME_TOOL_TIP];
871
    }
872

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

882
883
//        $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
884

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

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

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

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

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

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

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

        return $html;
935
    }
936

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

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

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

960
961
962
        return $content;
    }

Carsten  Rose's avatar
Carsten Rose committed
963
964
965
966
967
    /**
     * 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
968
     *
Carsten  Rose's avatar
Carsten Rose committed
969
970
971
972
973
974
975
976
977
     * @return string
     */
    private function doQuestion(array $vars) {

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

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

        $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];
987
988
989
        $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
990
991

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

alert.show();