Link.php

<?PHP
/***************************************************************
 *  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');
require_once(__DIR__ . '/Utils.php');
require_once(__DIR__ . '/../store/Store.php');
require_once(__DIR__ . '/../store/Sip.php');

/*
 * u:url
 * m:mailto
 * p:page
 * 
 * t:text
 * a:AltText
 * o:ToolTip
 * 
 * r:render   
 * g:target
 * c:class  [n|i|e]:<class>
 * 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 
 * h:hash  
 *
 * A:    A:[u:p:m]
 * G:    G:[N|..]
 */

class Link {

    //TODO: delete muss noch implementiert werden
    private $delete = '';

    /**
     * @var Sip
     */
    private $sip = null;

    /**
     * @var Store
     */
    private $store = null;

    // Simulate global variable: will be set much earlier in other functions. Will be shown in error messages.
    private $fr_error;

    /**
     * @var Utils
     */
    private $utils;
    /**
     * @var array
     */
    private $renderControl = array();
    private $linkClassSelector = array("i" => "internal", "e" => "external");
    private $cssLinkClassInternal = '';
    private $cssLinkClassExternal = '';

    /**
     * __construct
     *
     * @param $fr_error
     * @param Sip $sip
     */
    public function __construct($fr_error, Sip $sip, $phpUnit = false) {
        $this->fr_error = $fr_error;
        $this->sip = $sip;
        $this->store = Store::getInstance('', $phpUnit);
        $this->cssLinkClassInternal = $this->store->getVar(SYSTEM_CSS_LINK_CLASS_INTERNAL, STORE_SYSTEM);
        $this->cssLinkClassExternal = $this->store->getVar(SYSTEM_CSS_LINK_CLASS_EXTERNAL, STORE_SYSTEM);
        $this->initRenderControl();

    }

    /**
     * Initializes RenderControl Array
     *
     * @param    void
     * @return    void
     */
    private function initRenderControl() {

        $this->utils = new Utils();

        /*
         * mode:
         * 0: no output
         * 1: text
         * 2: url
         * 3: <a href=url>url</a>
         * 4: <a href=url>Text</a>
         *
         *  r=render mode, u=url, t:text and/or image.
         *
         *                  [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;
    }

    /**
     * Build the whole link
     *
     * @param    string $str :  Qualifier with params. 'report'-syntax. F.e.:  A:u:www.example.com|G:P:home.gif|t:Home"
     *
     * @return    string      The complete Link
     */
    public function renderLink($str) {
        $link = '';

        $vars = array();
        $this->clearVars($vars);

        // str="u:http://www.example.com|c:i|t:delete"
        $param = explode("|", $str);

        // Parse all parameter, fill variables
        foreach ($param as $item) {

            // set class defaults
            $this->parseItem($vars, $item);
        }

        // if there is no url or mailto definition: {{global.pageId}}
        if ($vars['url'] == '' && $vars['mailto'] == '') {
            $vars['url'] = "?" . $this->store->getVar(TYPO3_PAGE_ID, STORE_TYPO3);
        }

        $this->doCssClass($vars);

        $htmlUrl = $this->doUrl($vars);
        $htmlImage = $this->doImage($vars);

// Compose Image & Text
        $distance = ' ';
        $vars['text'] = ($vars['picturePosition'] == "l") ? $htmlImage . $distance . $vars['text'] : $vars['text'] . $distance . $htmlImage;

// ToolTip
        $extraSpan = ['', ''];
        if ($vars['toolTip']) {
            $extraSpan[0] = "<span " . $vars['toolTip'][0] . ">" . $vars['toolTip'][1];
            $extraSpan[1] = "</span>";
        }

// Create 'fake' modes for encrypted 'mailto'
        $prefix = "";
        if ($vars['mailto'] != '') {
            $prefix = "1";
            $vars['url'] = "dummy";
        }
// Create 'fake' mode for ajax delete
        if ($vars['delete']) {
            $prefix = "2";
        }
// Compose URL
// get Render Mode via Array renderControl
        $mode = $prefix . $this->renderControl[$vars['modeRender']][$vars['url'] ? 1 : 0][$vars['text'] ? 1 : 0];
// 0-4 URL, plain email
// 10-14 encrypted email
        switch ($mode) {
            // 0: No Output
            case '0':
            case '10':
            case '20':
            $link = "";
                break;

            // 1: 'text'
            case '1':
                $link = $extraSpan[0] . $vars['text'] . $extraSpan[1];
                break;
            case '11':
                $link = $extraSpan[0] . $this->encryptMailtoJS($vars, false) . $extraSpan[1];
                break;

            // 2: 'url'
            case '2':
                $link = $extraSpan[0] . $vars['url'] . $extraSpan[1];
                break;
            case '12':
                $link = $extraSpan[0] . $this->encryptMailtoJS($vars, false) . $extraSpan[1];
                break;

            // 3: <a href=url>url</a>
            case '3':
                $link = $htmlUrl . $vars['url'] . '</a>' . $vars['toolTip'][1];
                break;
            case '13':
                $vars['text'] = $vars['mailto'];
                $link = $this->encryptMailtoJS($vars, TRUE);
                break;

            // 4: <a href=url>Text</a>
            case '4':
                $link = $htmlUrl . $vars['text'] . '</a>' . $vars['toolTip'][1];
                break;
            case '14':
                $link = $this->encryptMailtoJS($vars, TRUE);
                break;
            case '21':
            case '22':
            case '23':
            case '24':
            //TODO: Alter Code, umstellen auf JS Client von RO. Vorlage koennte 'Delete' in Subrecord sein.
            $link = "<a href=\"javascript: void(0);\" onClick=\"var del = new FR.Delete({recordId:'',hash:'',forward:'" .
                $vars['pageAlias'] . "'});\" " . $vars['linkClass'] . ">" . $vars['text'] . "</a>";
        }

        return $link;

    }

    private function clearVars(&$vars) {
        $vars['mailto'] = "";
        $vars['url'] = "";
        $vars['pageAlias'] = '';

        $vars['image'] = "";
        $vars['text'] = "";
        $vars['altText'] = "";
        $vars['imageTitle'] = "";
        $vars['question'] = "";
        $vars['target'] = "";
        $vars['toolTip'] = ['', ''];
        $vars['additionalUrlParams'] = "";

        $vars['modeRender'] = 0;
        $vars['picturePosition'] = "l";
        $vars['modeHash'] = false;
        $vars['encryption'] = 1;
        $vars['delete'] = '';

        $vars['linkClass'] = ""; // class name
        $vars['defaultLinkClass'] = ''; // Depending of 'as page' or 'as url'. Only used if class is not explizit set.

    }

    /**
     * Parse Item of link string, fill class global variables.
     *
     * @param    string $key :    F.e.: 'u'
     * @param    string $value :  F.e.: 'http://www.nzz.ch'
     * @throws SyntaxReportException
     */
    private
    function parseItem(&$vars, $item) {
        $key = '';
        $value = '';

        $arr = explode(":", $item, 2);
        switch (count($arr)) {
            case 0:
                return;
                break;

            case 1:
                $key = $arr[0];
                break;

            case 2:
                $key = $arr[0];
                $value = $arr[1];
                break;

            default:
                throw new CodeException("This statement should never be reached", ERROR_CODE_SHOULD_NOT_HAPPEN);

        }

        switch ($key) {
            // URL
            case "u":
                if ($vars['url'] || $vars['mailto'])
                    throw new SyntaxReportException ("Multiple URL, PAGE or MAILTO defined : '$key'", "", null, __FILE__, __LINE__, "Column: " . $this->fr_error["columnIndex"], $this->fr_error);
                $vars['url'] = $value;
                $vars['defaultLinkClass'] = $this->cssLinkClassExternal;
                break;
            case "m":
                if ($vars['url'] || $vars['mailto'])
                    throw new SyntaxReportException ("Multiple URL, PAGE or MAILTO defined : '$key'", "", null, __FILE__, __LINE__, "Column: " . $this->fr_error["columnIndex"], $this->fr_error);
                $vars['mailto'] = $value;
                $vars['defaultLinkClass'] = $this->cssLinkClassExternal;
                break;
            case "p":
                if ($vars['url'] || $vars['mailto'])
                    throw new SyntaxReportException ("Multiple URL, PAGE or MAILTO defined : '$key'", "", null, __FILE__, __LINE__, "Column: " . $this->fr_error["columnIndex"], $this->fr_error);
                $vars['pageAlias'] = $value ? $value : $this->store->getVar(TYPO3_PAGE_ID, STORE_TYPO3); // If no pageid|pagealias is defined, take current page
//                $this->url = "?" . $this->pageAlias;
                $vars['defaultLinkClass'] = $this->cssLinkClassInternal;
                break;

            // Text
            case "t":
                $vars['text'] = $value;
                break;
            case "a":
                $vars['altText'] = $value;
                break;
            case "o":
                $vars['toolTip'] = $this->utils->createToolTip($value);
                break;

            // Image
            case "P":
                if ($vars['image'])
                    throw new SyntaxReportException ("Multiple images defined: '$key'", "", null, __FILE__, __LINE__, "Column: " . $this->fr_error["columnIndex"], $this->fr_error);
                $vars['image'] = $value;
                $vars['AltText'] = "Grafic: " . $value;
                $vars['imageTitle'] = $value;
                break;
            case "B":
                if ($vars['image'])
                    throw new SyntaxReportException ("Multiple images defined: '$key'", "", null, __FILE__, __LINE__, "Column: " . $this->fr_error["columnIndex"], $this->fr_error);
                $vars['image'] = PATH_ICONS . "bullet-" . ($value ? $value : "green") . '.gif';
                $vars['defaultAltText'] = "Bullet: " . $value;
                $vars['imageTitle'] = $value;
                break;
            case "C":
                if ($vars['image'])
                    throw new SyntaxReportException ("Multiple images defined: '$key'", "", null, __FILE__, __LINE__, "Column: " . $this->fr_error["columnIndex"], $this->fr_error);
                $vars['image'] = PATH_ICONS . "checked-" . ($value ? $value : "green") . '.gif';
                $vars['defaultAltText'] = "Checked: " . $value;
                $vars['imageTitle'] = $value;
                break;
            case "D":
                if ($vars['image'])
                    throw new SyntaxReportException ("Multiple images defined: '$key'", "", null, __FILE__, __LINE__, "Column: " . $this->fr_error["columnIndex"], $this->fr_error);
                $vars['image'] = PATH_ICONS . 'delete.gif';
                $vars['defaultAltText'] = "Delete";
                $vars['imageTitle'] = "Delete";
                $vars['delete'] = true;
                // Include Extjs library
                $this->utils->loadJSlib($this->fr_error);
                break;
            case "E":
                if ($vars['image'])
                    throw new SyntaxReportException ("Multiple images defined: '$key'", "", null, __FILE__, __LINE__, "Column: " . $this->fr_error["columnIndex"], $this->fr_error);
                $vars['image'] = PATH_ICONS . 'edit.gif';
                $vars['defaultAltText'] = "Edit";
                $vars['imageTitle'] = "Edit";
                break;
            case "H":
                if ($vars['image'])
                    throw new SyntaxReportException ("Multiple images defined: '$key'", "", null, __FILE__, __LINE__, "Column: " . $this->fr_error["columnIndex"], $this->fr_error);
                $vars['image'] = PATH_ICONS . 'help.gif';
                $vars['defaultAltText'] = "Help";
                $vars['imageTitle'] = "Help";
                break;
            case "I":
                if ($vars['image'])
                    throw new SyntaxReportException ("Multiple images defined: '$key'", "", null, __FILE__, __LINE__, "Column: " . $this->fr_error["columnIndex"], $this->fr_error);
                $vars['image'] = PATH_ICONS . 'info.gif';
                $vars['defaultAltText'] = "Information";
                $vars['imageTitle'] = "Information";
                break;
            case "N":
                if ($vars['image'])
                    throw new SyntaxReportException ("Multiple images defined: '$key'", "", null, __FILE__, __LINE__, "Column: " . $this->fr_error["columnIndex"], $this->fr_error);
                $vars['image'] = PATH_ICONS . 'new.gif';
                $vars['defaultAltText'] = "New";
                $vars['imageTitle'] = "New";
                break;
            case "S":
                if ($vars['image'])
                    throw new SyntaxReportException ("Multiple images defined: '$key'", "", null, __FILE__, __LINE__, "Column: " . $this->fr_error["columnIndex"], $this->fr_error);
                $vars['image'] = PATH_ICONS . 'show.gif';
                $vars['defaultAltText'] = "Details";
                $vars['imageTitle'] = "Details";
                break;

            // Misc
            case "r":
                if ($vars['modeRender'])
                    throw new SyntaxReportException ("Multiple render modes defined: '$key'", "", null, __FILE__, __LINE__, "Column: " . $this->fr_error["columnIndex"], $this->fr_error);
                $vars['modeRender'] = $value;
                break;
            case "g":
                if ($vars['target'])
                    throw new SyntaxReportException ("Multiple 'target' defined: '$key'", "", null, __FILE__, __LINE__, "Column: " . $this->fr_error["columnIndex"], $this->fr_error);
                $vars['target'] = $value;
                break;
            case "c":
                if ($vars['linkClass'])
                    throw new SyntaxReportException ("Multiple linkClass defined: '$key'", "", null, __FILE__, __LINE__, "Column: " . $this->fr_error["columnIndex"], $this->fr_error);
                $vars['linkClass'] = $value;
                break;
            case "q":
                if ($vars['question'])
                    throw new SyntaxReportException ("Multiple question defined: '$key'", "", null, __FILE__, __LINE__, "Column: " . $this->fr_error["columnIndex"], $this->fr_error);
                $vars['question'] = $value ? $value : "Please confirm";
                break;
            case "e":
                if ($vars['encryption'] != 1)
                    throw new SyntaxReportException ("Multiple encryption defined: '$key'", "", null, __FILE__, __LINE__, "Column: " . $this->fr_error["columnIndex"], $this->fr_error);
                $vars['encryption'] = $value ? $value : "1";
                break;
            case "h":
                if ($vars['modeHash'])
                    throw new SyntaxReportException ("Multiple modeHash defined: '$key'", "", null, __FILE__, __LINE__, "Column: " . $this->fr_error["columnIndex"], $this->fr_error);
                $vars['modeHash'] = TRUE;
                break;
            case "U":    //if($this->additionalUrlParams) throw new syntaxException ( "Multiple additionalUrlParams defined: '$key'","",__FILE__,__LINE__, "Column: " . $fthis->r_error["columnIndex"], $this->fr_error);
                $vars['additionalUrlParams'] = $value;
                break;
            case "R":
                if ($vars['picturePosition'] != "l")
                    throw new SyntaxReportException ("Multiple picturePosition defined: '$key'", "", null, __FILE__, __LINE__, "Column: " . $this->fr_error["columnIndex"], $this->fr_error);
                $vars['picturePosition'] = "r";
                break;

            // A,G
            case "G":
            case "A":
            // set class defaults
            $this->parseItem($vars, $value);
                break;
            case "" :
                break;
            default:
                throw new SyntaxReportException ("Unknown link qualifier: '$key'", "", null, __FILE__, __LINE__, "Column: " . $this->fr_error["columnIndex"], $this->fr_error);

        }

    }

    /**
     * Parse CSS Class Settings
     *
     * @param    void
     *
     * @return    void
     */
    private
    function doCssClass(&$vars) {
        $class = '';

        switch ($vars['linkClass']) {
            case 'n':
                $vars['linkClass'] = '';
                break;
            case 'i':
            case 'e':
            $vars['linkClass'] = $this->linkClassSelector[$vars['linkClass']];
                break;
            default:
                $vars['linkClass'] = ($vars['linkClass'] == '') ? $vars['defaultLinkClass'] : $vars['linkClass'];
                break;
        }
    }

    /**
     * Builds complete HTML anchor.
     * - <a href="mailto:info@example.com:>info@example.com</a>
     * - <a href="http://example.com:>http://example.com</a>
     * - If $this->modeHash is set, create a
     *
     * @return string
     * @throws SyntaxReportException
     */
    private
    function doUrl(&$vars) {
        $tags = '';
        // build URL
        $htmlUrl = "";

        if ($vars['url'] != '') {

            if ($vars['modeHash']) {

                $vars['url'] = $this->sip->queryStringToSip('id=' . $vars['pageAlias'] . '&' . $vars['additionalUrlParams']);

            } else {

                if ($vars['additionalUrlParams'] != '') {
                    // Append '&' or '?' depending if there is already a '?'
                    $vars['url'] .= (strpos($vars['url'], '?') >= 0) ? '&' : '?';
                    // Append all additional params.
                    $vars['url'] .= $vars['additionalUrlParams'];
                }
            }
        }

        // If there is no encryption: handle the mailto as an ordinary URL
        if ($vars['mailto'] != '') {

            if ($vars['encryption'] == 0) {
                $vars['url'] = "mailto:" . $vars['mailto'];
                $vars['mailto'] = "";
            } else {
                throw new SyntaxReportException ("Oops, sorry: encrypted mail not implemented ...", "", null, __FILE__, __LINE__,
                    "Column: " . $this->fr_error["columnIndex"], $this->fr_error);
            }
        }

        $tags .= Support::doAttribute('href', $vars['url']);
        $tags .= Support::doAttribute('class', $vars['linkClass']);
        $tags .= Support::doAttribute('target', $vars['target']);
        if ($vars['question']) {
            $tags .= Support::doAttribute('onclick', 'confirm(\'' . $vars['question'] . '\')');
        }

        $htmlUrl = '<a ' . $tags . $vars['toolTip'][0] . '>';

        return ($htmlUrl);
    }

    /**
     * Create Image HTML Tag
     * @return string $htmlImage
     * @internal param $void
     *
     */
    private
    function doImage($vars) {
        $tags = '';

        // Build Image
        if ($vars['image'] != '') {
            $tags .= Support::doAttribute('alttext', $vars['altText']);
            $tags .= Support::doAttribute('src', $vars['image']);
            $tags .= Support::doAttribute('title', $vars['title']);
        }

        return $tags == '' ? '' : '<img ' . $tags . '>';
    }

    /**
     *  Encrypt the mailto address via JS.
     *  Email address protected against email crawler (as long as they don't interpret JS).
     *
     *    <script language=javascript><!--
     *    var mm1 = name
     *    var mm2 = @domain.
     *    var ... = tld
     *    document.write("<a href=" + "mail" + "to:" + mm1 + mm2 + ... + ">" + name + "</a>")
     *    document.write("<a href=" + "mail" + "to:" + mm1 + mm2 + ... + ">" + @domain. + "</a>")
     *    document.write("<a href=" + "mail" + "to:" + mm1 + mm2 + ... + ">" + tld + "</a>")
     *    //--></script>';
     *
     * @param    string $mailto Email address to encrypt.
     * @param    string $text Text to wrap <a href..>, </a> around.
     * @param    string $class Optional class definition
     * @param    bool $href TRUE: create a '<a>',   false: just encrypt or show the email, no link.
     *
     * @return    string The complete Link
     */
    private
    function encryptMailtoJS($vars, $href = TRUE) {

        // Split $mailto
        $tmp = $this->splitAndAddDelimter($vars['mailto'], "@");
        $arr = array_merge($this->splitAndAddDelimter($tmp[0], "."), $this->splitAndAddDelimter($tmp[1], "."));

        $tt = "<script language=javascript><!--" . chr(10);
        $ii = 0;
        if ($href) {
            $dw = 'document.write("<a href=" + "mail" + "to:"';
            foreach ($arr as $value) {
                // Setup JS Variables
                $tt .= 'var mm' . $ii . '= "' . $value . '"' . chr(10);
                // Compose $dw (documentwrite statement)
                $dw .= ' + mm' . $ii++;
            }
            $dw .= ' + "' . $vars['class'] . str_replace('"', '\\"', $vars['toolTip'][0]) . '>"';
            $closeDw = '"</a>")';
        } else {
            $dw = 'document.write(';
            $closeDw = ')';
        }

        // Wrap mailto around text
        if ($vars['mailto'] == $vars['text']) {
            // Text is an email: wrap every single part of mailto.
            $ii = 0;
            foreach ($arr as $value) {
                $tt .= $dw . " + mm" . $ii++ . ' + ' . $closeDw . chr(10);
            }
        } else {
            // Single wrap text
            $tt .= $dw . ' + "' . $vars['text'] . '" + ' . $closeDw . chr(10);
        }

        $tt .= '//--></script>';
        if ($href) $tt .= $vars['toolTip'][1];

        return ($tt);
    }

    /**
     * Split a string around the $delimiter.
     *
     * Append the delimiter to each part except the last one.
     *
     * @param $mailto
     * @param $delimiter
     * @return array
     */
    private
    function splitAndAddDelimter($mailto, $delimiter) {
        $value = '';

        $arr = explode($delimiter, $mailto);            // split string

        foreach ($arr as $key => $value) {
            $arr[$key] = $value . $delimiter;
        }

        if (isset($key))
            $arr[$key] = $value;

        return ($arr);
    }
}