Link.php 43.4 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/UserReportExtension.php');
33
require_once(__DIR__ . '/../helper/KeyValueStringParser.php');
34
35
36
37
38
39
40
41
42
43
44
45

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

66
67
68
69
70

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

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';
102

103
104
105
const LINK_ANCHOR = 'linkAnchor';
const LINK_PICTURE = 'linkPicture';

106
107
const NO_CLASS = 'no_class';

Carsten  Rose's avatar
Carsten Rose committed
108
109
const DEFAULT_BULLET_COLOR = 'green';
const DEFAULT_CHECK_COLOR = 'green';
110
const DEFAULT_RENDER_MODE = '0';
Carsten  Rose's avatar
Carsten Rose committed
111
112
const DEFAULT_QUESTION_TEXT = 'Please confirm';
const DEFAULT_QUESTION_LEVEL = 'info';
113
const DEFAULT_ACTION_DELETE = 'r';
Carsten  Rose's avatar
Carsten Rose committed
114

Carsten  Rose's avatar
Carsten Rose committed
115
116
117
118
const QUESTION_INDEX_TEXT = 0;
const QUESTION_INDEX_LEVEL = 1;
const QUESTION_INDEX_BUTTON_OK = 2;
const QUESTION_INDEX_BUTTON_FALSE = 3;
119
120
const QUESTION_INDEX_TIMEOUT = 4;
const QUESTION_INDEX_FLAG_MODAL = 5;
Carsten  Rose's avatar
Carsten Rose committed
121

122
123
124
125
/**
 * Class Link
 * @package qfq
 */
126
127
class Link {

Carsten  Rose's avatar
Carsten Rose committed
128
    /**
129
     * @var Sip
Carsten  Rose's avatar
Carsten Rose committed
130
131
132
     */
    private $sip = null;

133
134
135
136
137
    /**
     * @var Store
     */
    private $store = null;

Carsten  Rose's avatar
Carsten Rose committed
138
    private $phpUnit;
139
    private $renderControl = array();
140
    private $linkClassSelector = array(TOKEN_CLASS_INTERNAL => "internal ", TOKEN_CLASS_EXTERNAL => "external ");
141
142
    private $cssLinkClassInternal = '';
    private $cssLinkClassExternal = '';
Carsten  Rose's avatar
Carsten Rose committed
143
    private $ttContentUid = '';
144

145
    private $callTable = [
Carsten  Rose's avatar
Carsten Rose committed
146
147
148
        TOKEN_URL => 'buildUrl',
        TOKEN_MAIL => 'buildMail',
        TOKEN_PAGE => 'buildPage',
Carsten  Rose's avatar
Carsten Rose committed
149
        TOKEN_DOWNLOAD => 'buildDownload',
Carsten  Rose's avatar
Carsten Rose committed
150
151
152
153
        TOKEN_TOOL_TIP => 'buildToolTip',
        TOKEN_PICTURE => 'buildPicture',
        TOKEN_BULLET => 'buildBullet',
        TOKEN_CHECK => 'buildCheck',
154
155
        TOKEN_DELETE => 'buildDeleteIcon',
        TOKEN_ACTION_DELETE => 'buildActionDelete',
Carsten  Rose's avatar
Carsten Rose committed
156
157
158
159
160
        TOKEN_EDIT => 'buildEdit',
        TOKEN_HELP => 'buildHelp',
        TOKEN_INFO => 'buildInfo',
        TOKEN_NEW => 'buildNew',
        TOKEN_SHOW => 'buildShow',
Carsten  Rose's avatar
Carsten Rose committed
161
        TOKEN_FILE => 'buildFile',
162
163
    ];

164
    private $tableVarName = [
Carsten  Rose's avatar
Carsten Rose committed
165
166
167
        TOKEN_URL => NAME_URL,
        TOKEN_MAIL => NAME_MAIL,
        TOKEN_PAGE => NAME_PAGE,
Carsten  Rose's avatar
Carsten Rose committed
168
        TOKEN_DOWNLOAD => NAME_DOWNLOAD,
Carsten  Rose's avatar
Carsten Rose committed
169
        TOKEN_DOWNLOAD_MODE => NAME_DOWNLOAD_MODE,
Carsten  Rose's avatar
Carsten Rose committed
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
        TOKEN_TEXT => NAME_TEXT,
        TOKEN_ALT_TEXT => NAME_ALT_TEXT,
        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_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,
189
        TOKEN_RIGHT => NAME_RIGHT,
190
        TOKEN_ACTION_DELETE => NAME_ACTION_DELETE,
Carsten  Rose's avatar
Carsten Rose committed
191
        TOKEN_FILE => NAME_FILE,
192
193
    ];

Carsten  Rose's avatar
Carsten Rose committed
194
    // Used to find double definitions.
195
196
197
198
    private $tokenMapping = [
        TOKEN_URL => LINK_ANCHOR,
        TOKEN_MAIL => LINK_ANCHOR,
        TOKEN_PAGE => LINK_ANCHOR,
Carsten  Rose's avatar
Carsten Rose committed
199
        TOKEN_DOWNLOAD => LINK_ANCHOR,
Carsten  Rose's avatar
Carsten Rose committed
200

201
202
203
204
205
206
207
208
209
210
        TOKEN_PICTURE => LINK_PICTURE,
        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,
    ];
211

212
213
214
    /**
     * __construct
     *
215
     * @param Sip $sip
216
     * @param bool $phpUnit
217
     */
218
    public function __construct(Sip $sip, $phpUnit = false) {
Carsten  Rose's avatar
Carsten Rose committed
219
        $this->phpUnit = $phpUnit;
220
221
222
223
224

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

Carsten  Rose's avatar
Carsten Rose committed
225
        $this->sip = $sip;
Carsten  Rose's avatar
Carsten Rose committed
226
        $this->store = Store::getInstance('', $phpUnit);
227
228
        $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
229
        $this->ttContentUid = $this->store->getVar(TYPO3_TT_CONTENT_UID, STORE_TYPO3);
230
231
232
233
234
235
236
237
238

        /*
         * mode:
         * 0: no output
         * 1: text
         * 2: url
         * 3: <a href=url>url</a>
         * 4: <a href=url>Text</a>
         *
Carsten  Rose's avatar
Carsten Rose committed
239
         *  r=render mode, u=url, t:text and/or image.
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
         *
         *                  [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;
273

274
    }
275
276
277
278

    /**
     * Build the whole link
     *
279
     * @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
280
     * @return string The complete HTML encoded Link like <a href='http://example.com' class='external'><img src='iconf.gif' title='help text'>Description</a>
281
     * @throws UserReportException
282
     */
Carsten  Rose's avatar
Carsten Rose committed
283
    public function renderLink($str) {
284

285
        $tokenGiven = array();
286

287
288
        if (empty($str))
            return '';
289

290
        $vars = $this->fillParameter($str, $tokenGiven);
Carsten  Rose's avatar
Carsten Rose committed
291
        $vars = $this->processParameter($vars, $tokenGiven);
292
        $mode = $this->getModeRender($vars);
293

Carsten  Rose's avatar
Carsten Rose committed
294
295
296
297
        if (isset($tokenGiven[TOKEN_DOWNLOAD]) && $tokenGiven[TOKEN_DOWNLOAD] === true) {
            $this->store->setVar(SYSTEM_DOWNLOAD_POPUP, DOWNLOAD_POPUP_REQUEST, STORE_SYSTEM);
        }

298
        $link = '';
299

300
301
        // 0-4 URL, plain email
        // 10-14 encrypted email
302
303
304
305
306
        switch ($mode) {
            // 0: No Output
            case '0':
            case '10':
            case '20':
307
            $link = "";
308
309
310
311
                break;

            // 1: 'text'
            case '1':
312
                $link = $vars[FINAL_CONTENT];
313
314
                break;
            case '11':
315
316
                $link = $vars[FINAL_CONTENT];
//                $link = $this->encryptMailtoJS($vars, false);
317
318
319
320
                break;

            // 2: 'url'
            case '2':
321
                $link = $vars[FINAL_HREF];
322
323
                break;
            case '12':
324
325
                $link = $vars[FINAL_HREF];
//                $link = $this->encryptMailtoJS($vars, false);
326
327
                break;

328
            // 3: <a href=url ...>url</a>
329
            case '3':
Carsten  Rose's avatar
Carsten Rose committed
330
//                $link = $htmlUrl . $vars[NAME_URL] . '</a>' . $vars[NAME_TOOL_TIP_JS][1];
331
                $link = Support::wrapTag($vars[FINAL_ANCHOR], $vars[FINAL_HREF]);
332
333
                break;
            case '13':
334
335
336
                $link = Support::wrapTag($vars[FINAL_ANCHOR], $vars[FINAL_HREF]);
//                $vars[NAME_TEXT] = $vars[NAME_MAIL];
//                $link = $this->encryptMailtoJS($vars, true);
337
338
                break;

339
            // 4: <a href=url ...>Text</a>
340
            case '4':
341
                $link = Support::wrapTag($vars[FINAL_ANCHOR], $vars[FINAL_CONTENT]);
342
343
                break;
            case '14':
344
345
                $link = Support::wrapTag($vars[FINAL_ANCHOR], $vars[FINAL_CONTENT]);
//                $link = $this->encryptMailtoJS($vars, true);
346
347
348
349
350
                break;
            case '21':
            case '22':
            case '23':
            case '24':
351
            //TODO: Alter Code, umstellen auf JS Client von RO. Vorlage koennte 'Delete' in Subrecord sein.
Carsten  Rose's avatar
Carsten Rose committed
352
            $link = "<a href=\"javascript: void(0);\" onClick=\"var del = new FR.Delete({recordId:'',sip:'',forward:'" .
353
                $vars[NAME_PAGE] . "'});\" " . $vars[NAME_LINK_CLASS] . ">" . $vars[NAME_TEXT] . "</a>";
354
355
        }

356
357
358
        return $link;
    }

359
    /**
360
     * Order $param. Parameter with Priotrity are hardcoded at the moment.
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
     *
     * @param array $param
     * @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);
    }
382

383
    /**
384
     * @param string $str
385
     * @param array $tokenGiven
386
     * @return array
387
     * @throws UserReportException
388
     */
389
    private function fillParameter($str, array &$tokenGiven) {
390

Carsten  Rose's avatar
Carsten Rose committed
391
        // Define all possible vars: no more isset().
392
393
        $vars = $this->initVars();
        $flagArray = array();
394

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

398
399
        $param = $this->paramPriority($param);

Carsten  Rose's avatar
Carsten Rose committed
400
        // Parse all parameter, fill variables.
401
        foreach ($param as $item) {
402

403
            // Skip empty entries
404
405
406
            if ($item === '') {
                continue;
            }
407

408
409
410
411
            // u:www.example.com
            $arr = explode(":", $item, 2);
            $key = isset($arr[0]) ? $arr[0] : '';
            $value = isset($arr[1]) ? $arr[1] : '';
412

413
            // Bookkeeping defined parameter.
414
415
416
417
418
419
            if (isset($tokenGiven[$key])) {
                throw new UserReportException ("Multiple definitions for key '$key'", ERROR_MULTIPLE_DEFINITION);
            }
            $tokenGiven[$key] = true;

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

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

Carsten  Rose's avatar
Carsten Rose committed
425
            $value = $this->checkForEmptyValue($key, $value);
426
            $value = $this->checkValue($key, $value);
427

428
            // Store value
Carsten  Rose's avatar
Carsten Rose committed
429
430
431
432
433
434
435
436
437
438
            if (isset($tokenGiven[TOKEN_DOWNLOAD]) && ($key == TOKEN_URL || $key == TOKEN_URL_PARAM || $key == TOKEN_FILE)) {

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

                unset($tokenGiven[$key]); // Skip Bookkeeping for TOKEN_URL_PARAM | TOKEN_FILE | TOKEN_URL.
                continue;
            } else {
                $vars[$keyName] = $value;
            }

439

440
441
442
443
444
            // 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
445
                    throw new UserReportException ("Multiple definitions of url/mail/page/download or picture", ERROR_MULTIPLE_DEFINITION);
446
447
448
449
450
451
452
                }
                $flagArray[$type] = true;

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

455
456
457
458
            if (isset($this->callTable[$key])) {
                $build = $this->callTable[$key];
                $vars = $this->$build($vars, $value);
            }
459
460
        }

461
        // Final Checks
Carsten  Rose's avatar
Carsten Rose committed
462
        $this->checkParam($tokenGiven, $vars);
463

464
465
466
467
468
469
470
471
472
        return $vars;
    }

    /**
     * Cleans and make existing the standard vars used every time to render a link.
     *
     * @return array
     */
    private function initVars() {
473

474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
        return [
            NAME_MAIL => '',
            NAME_URL => '',
            NAME_PAGE => '',

            NAME_TEXT => '',
            NAME_ALT_TEXT => '',
            NAME_IMAGE => '',
            NAME_IMAGE_TITLE => '',
            NAME_GLYPH => '',
            NAME_GLYPH_TITLE => '',
            NAME_QUESTION => '',
            NAME_TARGET => '',
            NAME_TOOL_TIP => '',
            NAME_TOOL_TIP_JS => '',
            NAME_URL_PARAM => '',
Carsten  Rose's avatar
Carsten Rose committed
490
            NAME_EXTRA_CONTENT_WRAP => '',
Carsten  Rose's avatar
Carsten Rose committed
491
492
            NAME_DOWNLOAD_MODE => '',
            NAME_DOWNLOAD_ELEMENTS => array(),
493
494
495
496
497
498
499
500
501
502

            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.

503
504
            NAME_ACTION_DELETE => '',

505
506
507
508
509
510
511
            FINAL_HREF => '',
            FINAL_CONTENT => '',
            FINAL_SYMBOL => '',
            FINAL_TOOL_TIP => '',
            FINAL_CLASS => '',
            FINAL_QUESTION => ''
        ];
512

513
514
    }

515
    /**
Carsten  Rose's avatar
Carsten Rose committed
516
     * Verify Empty values. If appropriate, set defaults, if not throw an exception.
517
     *
Carsten  Rose's avatar
Carsten Rose committed
518
     * @param string $key
Carsten  Rose's avatar
Carsten Rose committed
519
     * @param string $value
520
521
522
     * @return string
     * @throws UserReportException
     */
Carsten  Rose's avatar
Carsten Rose committed
523
524
525
526
527
    private function checkForEmptyValue($key, $value) {

        if ($value !== '') {
            return $value;
        }
Carsten  Rose's avatar
Carsten Rose committed
528
529
        $value = '';

530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
        switch ($key) {
            case TOKEN_URL:
                throw new UserReportException ("Missing value for token '$key'", ERROR_MISSING_VALUE);
                break;
            case TOKEN_MAIL:
                throw new UserReportException ("Missing value for token '$key'", ERROR_MISSING_VALUE);
                break;
            case TOKEN_PAGE:
                $value = $this->store->getVar(TYPO3_PAGE_ID, STORE_TYPO3); // If no pageid|pagealias is defined, take current page
                break;
            case TOKEN_RIGHT:
                $value = 'r';
                break;
            case TOKEN_ENCRYPTION:
                $value = '1';
                break;
            case TOKEN_SIP:
                $value = '1';
                break;
Carsten  Rose's avatar
Carsten Rose committed
549
550
551
            case TOKEN_QUESTION:
                $value = DEFAULT_QUESTION_TEXT;
                break;
552
553
554
            case TOKEN_RENDER:
                $value = DEFAULT_RENDER_MODE;
                break;
555
556
557
            case TOKEN_ACTION_DELETE:
                $value = DEFAULT_ACTION_DELETE;
                break;
558
559
560
561
562
563
564
            default:
        }

        return $value;
    }

    /**
565
566
     * Validate value for token
     *
567
568
569
570
571
572
573
574
575
576
     * @param $key
     * @param $value
     * @return mixed
     * @throws UserReportException
     */
    private function checkValue($key, $value) {
        switch ($key) {
            case TOKEN_ENCRYPTION:
            case TOKEN_SIP:
                if ($value !== '0' && $value !== '1') {
577
                    throw new UserReportException ("Invalid value for token '$key': '$value''", ERROR_INVALID_VALUE);
578
579
                }
                break;
580
581
582
583
584
585
586
587
588
589
            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;
590
591
592
593
594
595
            default:
        }

        return $value;
    }

596
597
598
599
600
601
    /**
     * Check for double definition.
     *
     * @param array $tokenGiven
     * @throws UserReportException
     */
Carsten  Rose's avatar
Carsten Rose committed
602
    private function checkParam(array $tokenGiven, array $vars) {
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
        $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) {
622
623
            throw new UserReportException ("Multiple URL / PAGE and MAILTO definition", ERROR_MULTIPLE_URL_PAGE_MAILTO_DEFINITION);
        }
624

625
626
627
628
629
630
        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);
631
        }
Carsten  Rose's avatar
Carsten Rose committed
632
633
634
635

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

    /**
639
     * Compute final link parameter.
640
     *
Carsten  Rose's avatar
Carsten Rose committed
641
     * @param array $vars
Carsten  Rose's avatar
Carsten Rose committed
642
     * @param array $tokenGiven
643
644
     * @return string
     * @throws UserReportException
645
     */
Carsten  Rose's avatar
Carsten Rose committed
646
    private function processParameter(array $vars, array $tokenGiven) {
647

Carsten  Rose's avatar
Carsten Rose committed
648
        $vars[FINAL_HREF] = $this->doHref($vars, $tokenGiven); // must be called before doToolTip()
649
650
651
        $vars[FINAL_TOOL_TIP] = $this->doToolTip($vars);
        $vars[FINAL_CLASS] = $this->doCssClass($vars);
        $vars[FINAL_SYMBOL] = $this->doSymbol($vars);
Carsten  Rose's avatar
Carsten Rose committed
652
653
        $vars[FINAL_CONTENT] = $this->doContent($vars); // must be called after doSymbol()
        $vars[FINAL_QUESTION] = $this->doQuestion($vars);
654
        $vars[FINAL_ANCHOR] = $this->doAnchor($vars);
655

656
        return $vars;
657
    }
658

Carsten  Rose's avatar
Carsten Rose committed
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
    /**
     * @param array $vars
     * @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) {
                $mode = (substr($vars[NAME_DOWNLOAD_ELEMENTS][0], 0, 1) == TOKEN_FILE) ? DOWNLOAD_MODE_FILE : DOWNLOAD_MODE_PDF;
            } 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;
    }

698
    /**
699
     * Concat final HREF string
700
     *
701
     * @param array $vars
Carsten  Rose's avatar
Carsten Rose committed
702
     * @param array $tokenGiven
703
     * @return string
Carsten  Rose's avatar
Carsten Rose committed
704
     * @throws CodeException
705
     * @throws UserReportException
706
     */
Carsten  Rose's avatar
Carsten Rose committed
707
    private function doHref(array &$vars, array $tokenGiven) {
708
        $urlNParam = '';
709

Carsten  Rose's avatar
Carsten Rose committed
710
711
712
713
714
715
716
717
718
719
720
721
722

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

723
724
725
726
        if ($vars[NAME_ACTION_DELETE] !== '') {
            $vars[NAME_URL_PARAM] = $this->adjustDeleteParameter($vars[NAME_ACTION_DELETE], $vars[NAME_URL_PARAM]);
        }

727
        if ($vars[NAME_MAIL] === '') {
728
729
730
731
732

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

733
734
            // Either NAME_URL is empty or NAME_PAGE is empty
            $urlNParam = Support::concatUrlParam($vars[NAME_URL] . $vars[NAME_PAGE], $vars[NAME_URL_PARAM]);
735

Carsten  Rose's avatar
Carsten Rose committed
736
            if ($vars[NAME_SIP] === "1") {
737
738
                $paramArray = $this->sip->queryStringToSip($urlNParam, RETURN_ARRAY);
                $urlNParam = $paramArray['_url'];
739

740
                if ($this->store->getVar(SYSTEM_SHOW_DEBUG_INFO, STORE_SYSTEM) === SYSTEM_SHOW_DEBUG_INFO_YES) {
Carsten  Rose's avatar
Carsten Rose committed
741
                    $vars[NAME_TOOL_TIP] .= PHP_EOL . PHP_EOL . $this->sip->debugSip($paramArray);
742
743
                }
            }
744
745
            // Link: MAILTO
        } else {
746
            // If there is no encryption: handle the mailto as an ordinary URL
747
            if ($vars[NAME_ENCRYPTION] === '1') {
748
                throw new UserReportException ("Oops, sorry: encrypted mail not implemented ...", ERROR_NOT_IMPLEMENTED);
749
750
            } else {
                $urlNParam = "mailto:" . $vars[NAME_MAIL];
751
752
753
            }
        }

754
755
        return $urlNParam;
    }
756

757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
    /**
     * @param $tokenActionDelete
     * @param $nameUrlParam
     * @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;
    }

792
793
794
795
796
797
798
    /**
     * Return $vars[NAME_TOOL_TIP]. If $vars[NAME_TOOL_TIP] is empty, set $vars[NAME_GLYPH_TITLE] as tooltip.
     *
     * @param array $vars
     * @return mixed
     */
    private function doToolTip(array $vars) {
799

800
801
802
        // Set default tooltip
        if ($vars[NAME_TOOL_TIP] == '') {
            $vars[NAME_TOOL_TIP] = $vars[NAME_GLYPH_TITLE];
Carsten  Rose's avatar
Carsten Rose committed
803
        }
804

805
        return $vars[NAME_TOOL_TIP];
806
    }
807

808
    /**
809
     * Parse CSS Class Settings
810
     *
811
812
     * @param array $vars
     * @return    string
813
     */
814
    private function doCssClass(array $vars) {
815

816
        $class = ($vars[NAME_LINK_CLASS] === '') ? $vars[NAME_LINK_CLASS_DEFAULT] : $vars[NAME_LINK_CLASS];
Carsten  Rose's avatar
Carsten Rose committed
817

818
819
820
821
822
823
824
825
826
827
828
        switch ($class) {
            case TOKEN_CLASS_NONE:
                $class = '';
                break;
            case TOKEN_CLASS_INTERNAL:
            case TOKEN_CLASS_EXTERNAL:
                $class = $this->linkClassSelector[$vars[NAME_LINK_CLASS]] . ' ';
                break;
            default:
                break;
        }
829

830
831
832
        if ($class === NO_CLASS) {
            $class = '';
        }
833

Carsten  Rose's avatar
Carsten Rose committed
834
        if ($vars[NAME_GLYPH] !== '' && $vars[NAME_EXTRA_CONTENT_WRAP] == '') {
835
836
            $class .= 'btn btn-default ';
        }
837

838
        return $class;
839
    }
840

841
842
843
    /**
     * Create Image HTML Tag
     *
844
845
     * @param array $vars
     * @return string
846
     */
847
    private function doSymbol(array $vars) {
848
        $tags = '';
849
        $html = '';
850
851

        // Build Image
852
        if ($vars[NAME_IMAGE] !== '') {
853
854
            $tags .= Support::doAttribute('alt', $vars[NAME_ALT_TEXT]);
            $tags .= Support::doAttribute('src', $vars[NAME_IMAGE]);
855
            $tags .= Support::doAttribute('title', $vars[FINAL_TOOL_TIP] === '' ? $vars[NAME_IMAGE_TITLE] : $vars[FINAL_TOOL_TIP]);
856
            $html .= '<img ' . $tags . '>';
857
858
        }

859
860
861
862
863
864
        if ($vars[NAME_GLYPH] !== '') {
            $tags = Support::doAttribute('class', 'glyphicon ' . $vars[NAME_GLYPH]);
            $html .= Support::wrapTag('<span ' . $tags . '>', '', false);
        }

        return $html;
865
    }
866

867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
    /**
     * Concat Text and/or Image and or Glyph. $vars[NAME_RIGHT_PICTURE_POSITION]
     * Concat Text and/or Image and or Glyph. Depending of $vars[NAME_RIGHT_PICTURE_POSITION], swapp the position,
     *
     * @param array $vars
     * @return string
     */
    private function doContent(array $vars) {

        $htmlImage = $vars[FINAL_SYMBOL];

        // Compose Image & Text
        if ($htmlImage === '') {
            $content = $vars[NAME_TEXT];
        } elseif ($vars[NAME_TEXT] === '') {
            $content = $htmlImage;
        } else {
            if ($vars[NAME_RIGHT] === "l") {
                $content = implode(' ', [$htmlImage, $vars[NAME_TEXT]]);
            } else {
                $content = implode(' ', [$vars[NAME_TEXT], $htmlImage]);
            }
        }

Carsten  Rose's avatar
Carsten Rose committed
891
892
893
894
        if ($vars[NAME_EXTRA_CONTENT_WRAP] != '') {
            $content = Support::wrapTag($vars[NAME_EXTRA_CONTENT_WRAP], $content);
        }

895
896
897
        return $content;
    }

Carsten  Rose's avatar
Carsten Rose committed
898
899
900
901
902
903
904
905
906
907
908
909
910
911
    /**
     * 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
     * @return string
     */
    private function doQuestion(array $vars) {

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

        $arr = OnArray::explodeWithoutEscaped(':', $vars[NAME_QUESTION]);
912
        $arr = array_merge($arr, ['', '', '', '', '', '']);
Carsten  Rose's avatar
Carsten Rose committed
913
914
915
916
917
918
919
920

        $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];
921
922
923
        $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
924
925

        $js = <<<EOF
926
var alert = new QfqNS.Alert({ message: '$text', type: '$level', modal: $flagModal, timeout: $timeout, buttons: [
Carsten  Rose's avatar
Carsten Rose committed
927
928
    { label: '$ok', eventName: 'ok' },
    { label: '$cancel',eventName: 'cancel'}
929
] } );
Carsten  Rose's avatar
Carsten Rose committed
930
931
932
933
934
935
936
937
938
939
940
941
942
943
alert.on('alert.ok', function() {
  window.location = $('#$id').attr('href');
});

alert.show();
return false;
EOF;

        $content .= Support::doAttribute('onClick', $js);


        return $content;
    }

944
945
946
947
948
949
950
951
952
    /**
     * Create the HTML anchor.
     * - <a href="mailto:info@example.com" title=".." class="..">
     * - <a href="http://example.com" title=".." class="..">
     *
     * @param array $vars
     * @return string
     * @throws UserReportException
     */
Carsten  Rose's avatar
Carsten Rose committed
953
    private function doAnchor(array $vars) {
Carsten  Rose's avatar
Carsten Rose committed
954

955
956
        $attributes = '';

Carsten  Rose's avatar
Carsten Rose committed
957

958
959
960
961
        $attributes .= Support::doAttribute('href', $vars[FINAL_HREF]);
        $attributes .= Support::doAttribute('class', $vars[FINAL_CLASS]);
        $attributes .= Support::doAttribute('target', $vars[NAME_TARGET]);
        $attributes .= Support::doAttribute('title', $vars[FINAL_TOOL_TIP]);
Carsten  Rose's avatar
Carsten Rose committed
962
        $attributes .= $vars[FINAL_QUESTION];
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988

        $anchor = '<a ' . $attributes . '>';
        return $anchor;
    }

    /**
     * Get mode from table $this->renderControl, depending on $modeRender, $modeUrl, $modeText
     *
     * @param array $vars
     * @param string $prefix
     * @return string
     * @throws UserReportException
     */
    private function getModeRender(array $vars, $prefix = '') {

        $modeRender = $vars[NAME_RENDER];
        $modeUrl = ($vars[FINAL_HREF] === '') ? 0 : 1;
        $modeText = ($vars[FINAL_CONTENT] === '') ? 0 : 1;

        // Create 'fake' modes for encrypted 'mailto'
        $prefix = "";
        if ($vars[NAME_MAIL] != '') {
            $prefix = "1";
//            $vars[NAME_URL] = "dummy";
        }

989
        // Create 'fake' mode for ajax/html delete
990
991
992
993
994
995
996
997
998
999
1000
        if ($vars[NAME_DELETE]) {
            $prefix = "2";
        }

        if (isset($this->renderControl[$modeRender][$modeUrl][$modeText])) {
            $mode = $prefix . $this->renderControl[$modeRender][$modeUrl][$modeText];
        } else {
            throw new UserReportException ("Undefined combination of 'rendering mode' / 'url' / 'text': " .
                $modeRender . ' / ' . $modeUrl . ' / ' . $modeText, ERROR_UNDEFINED_RENDER_CONTROL_COMBINATION);
        }