HighlightRenderer.php

<?php
/*
 SPDX-FileCopyrightText: © 2014-2015 Siemens AG
 Authors: Andreas Würl, Daniele Fognini
 
 SPDX-License-Identifier: GPL-2.0-only
*/
 
namespace Fossology\Lib\View;
 
use Fossology\Lib\Data\Highlight;
use Fossology\Lib\Data\SplitPosition;
 
class HighlightRenderer
{
  const DEFAULT_PADDING = 0;
 
  public $classMapping = array('' => '',
            Highlight::UNDEFINED=>'hi-undefined',
 
            Highlight::MATCH => 'hi-match',
            Highlight::CHANGED => 'hi-changed',
            Highlight::ADDED => 'hi-added',
            Highlight::DELETED => 'hi-deleted',
            Highlight::SIGNATURE => 'hi-signature',
            Highlight::KEYWORD => 'hi-keyword',
            Highlight::BULK => 'hi-bulk',
            Highlight::COPYRIGHT => 'hi-cp',
            Highlight::EMAIL => 'hi-email',
            Highlight::URL => 'hi-url',
            Highlight::AUTHOR => 'hi-author',
            Highlight::BULK => 'hi-bulk',
            Highlight::IPRA => 'hi-ipra',
            Highlight::ECC => 'hi-mediumorchid',
            Highlight::KEYWORDOTHERS => 'hi-teal'
          );
 
  public function createSpanStart(SplitPosition &$entry)
  {
    $depth = $entry->getLevel();
    $highlight = $entry->getHighlight();
    $type = $highlight ? $highlight->getType() : Highlight::UNDEFINED;
 
    $wrappendElement = "";
 
    if ($highlight) {
      $htmlElement = $highlight->getHtmlElement();
      if ($htmlElement) {
        $wrappendElement = $htmlElement->getOpeningText();
      }
    }
 
    return $this->createStyleWithPadding($type, $highlight->getInfoText(), $depth) . $wrappendElement;
  }
 
  public function createSpanEnd(SplitPosition $entry)
  {
    $highlight = $entry->getHighlight();
 
    $wrappendElement = "";
 
    if ($highlight) {
      $htmlElement = $highlight->getHtmlElement();
      if ($htmlElement) {
        $wrappendElement = $htmlElement->getClosingText();
      }
    }
 
    return $wrappendElement . '</span>';
  }
 
  public function createStyleWithPadding($type, $title, $depth = 0)
  {
    $style = $this->createStartSpan($type, $title);
    if ($depth < self::DEFAULT_PADDING) {
      $padd = (2 * (self::DEFAULT_PADDING - $depth - 2)) . 'px';
      return $this->getStyleWithPadding($padd, $style);
    } else {
      return $style;
    }
  }
 
  public function getStyleWithPadding($padding, $style)
  {
    return str_replace('background', "padding-top:$padding;padding-bottom:$padding;background", $style);
  }
 
  public function createStartSpan($type, $title)
  {
    if ($type == 'K ' || $type == 'K') {
      return "<span class=\"hi-keyword\">";
    }
    if (! array_key_exists($type, $this->classMapping)) {
      $type = Highlight::UNDEFINED;
    }
    $class = $this->classMapping[$type];
    return "<span class=\"$class\" title=\"$title\">";
  }
 
  public function getLegendData($containsDiff)
  {
    $data = array();
 
    $colorDefinition = $containsDiff
        ? array(
            '' => _('license text:'),
            Highlight::MATCH => _('&nbsp;- identical'),
            Highlight::CHANGED => _('&nbsp;- modified'),
            Highlight::ADDED => _('&nbsp;- added'),
            Highlight::DELETED => _('&nbsp;- removed'),
            Highlight::SIGNATURE => _('license relevant text'),
            Highlight::KEYWORD => _('keyword'),
            Highlight::BULK => _('bulk'))
        : array(
            Highlight::UNDEFINED => _("license relevant text"));
    foreach ($colorDefinition as $colorKey => $txt) {
      $data[] = array('class'=>$this->classMapping[$colorKey], 'text' => $txt);
    }
    return $data;
  }
}