FO_Plugin.php

<?php
/***********************************************************
 * Copyright (C) 2008-2013 Hewlett-Packard Development Company, L.P.
 * Copyright (C) 2014-2017 Siemens AG
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * version 2 as published by the Free Software Foundation.
 *
 * This program 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.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 ***********************************************************/

use Fossology\Lib\Auth\Auth;
use Fossology\Lib\Plugin\Plugin;
use Fossology\Lib\UI\Component\MicroMenu;
use Fossology\Lib\UI\Component\Menu;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;

define("PLUGIN_STATE_FAIL", -1); // mark it as a total failure
define("PLUGIN_STATE_INVALID", 0);
define("PLUGIN_STATE_VALID", 1); // used during install
define("PLUGIN_STATE_READY", 2); // used during post-install

define("PLUGIN_DB_NONE", 0);
define("PLUGIN_DB_READ", 1);
define("PLUGIN_DB_WRITE", 3);        /* DB writes permitted */
define("PLUGIN_DB_CADMIN", 5);       /* DB writes permitted, with additional clearing permissions */
define("PLUGIN_DB_ADMIN", 10);        /* add/delete users */



$NoneText = _("None");
$ReadText = _("Read");
$WriteText = _("Write");
$AdminText = _("Admin");
$cAdminText = _("Clearing Admin");
$GLOBALS['PERM_NAMES'] = array(Auth::PERM_NONE => $NoneText, Auth::PERM_READ => $ReadText, Auth::PERM_WRITE => $WriteText, Auth::PERM_ADMIN => $AdminText, Auth::PERM_CADMIN => $cAdminText);

class FO_Plugin implements Plugin
{
  var $State = PLUGIN_STATE_INVALID;

  var $Name = "";
  var $Version = "1.0";
  var $Title = "";  // used for HTML title tags and window menu bars

  var $DBaccess = PLUGIN_DB_NONE; /* what kind of access is needed? */
  var $LoginFlag = 0;        /* Must you be logged in to access this plugin? 1=yes, 0=no */

  var $NoMenu = 0;        /* 1 = Don't show the HTML menu at the top of page */
  var $NoHeader = 0;        /* 1 = Don't show the HTML header at the top of page */

  var $PluginLevel = 10; /* used for sorting plugins -- higher comes first after dependencies are met */
  var $Dependency = array();
  var $InitOrder = 0;

  private $menu;

  protected $microMenu;

  protected $renderer;

  private $request;

  private $headers = array();

  protected $vars = array();

  var $MenuList = NULL;
  var $MenuOrder = 0;
  var $MenuTarget = NULL;

  function Install()
  {
    return 0;
  }

  function Remove()
  {
    return;
  }

  public function __construct()
  {
    $this->OutputType = $this->OutputType ?: "HTML";
    $this->State = PLUGIN_STATE_VALID;
    register_plugin($this);

    global $container;
    $this->menu = $container->get('ui.component.menu');
    $this->microMenu = $container->get('ui.component.micromenu');
    $this->renderer = $container->get('twig.environment');
  }

  function Initialize()
  {
    return (true);
  } // Initialize()

  function PostInitialize()
  {
    if ($this->State != PLUGIN_STATE_VALID) {
      return 0;
    } // don't run

    if (empty($_SESSION['User']) && $this->LoginFlag) {
      return 0;
    }
    // Make sure dependencies are met
    foreach ($this->Dependency as $key => $val) {
      $id = plugin_find_id($val);
      if ($id < 0) {
        $this->Destroy();
        return (0);
      }
    }

    // Put your code here!
    // If this fails, set $this->State to PLUGIN_STATE_INVALID.
    // If it succeeds, then set $this->State to PLUGIN_STATE_READY.

    // It worked, so mark this plugin as ready.
    $this->State = PLUGIN_STATE_READY;
    // Add this plugin to the menu
    if ($this->MenuList !== "") {
      menu_insert("Main::" . $this->MenuList, $this->MenuOrder, $this->Name, $this->MenuTarget);
    }
    return ($this->State == PLUGIN_STATE_READY);
  } // PostInitialize()

  function RegisterMenus()
  {
    if ($this->State != PLUGIN_STATE_READY) {
      return (0);
    } // don't run
    // Add your own menu items here.
    // E.g., menu_insert("Menu_Name::Item");
  }

  function Destroy()
  {
    $this->State = PLUGIN_STATE_INVALID;
  }

  /* Possible values: Text, HTML, XML, JSON */
  var $OutputType = "HTML";
  var $OutputToStdout = 0;

  function OutputOpen()
  {
    if ($this->State != PLUGIN_STATE_READY) {
      return (0);
    }

    $this->headers['Content-type'] = 'text/html';
    $this->headers['Pragma'] = 'no-cache';
    $this->headers['Cache-Control'] = 'no-cache, must-revalidate, maxage=1, post-check=0, pre-check=0';
    $this->headers['Expires'] = 'Expires: Thu, 19 Nov 1981 08:52:00 GMT';

    $metadata = "<meta name='description' content='The study of Open Source'>\n";
    $metadata .= "<meta http-equiv='Content-Type' content='text/html;charset=UTF-8'>\n";

    $this->vars['metadata'] = $metadata;

    if (!empty($this->Title)) {
      $this->vars['title'] = htmlentities($this->Title);
    }

    $styles = "<link rel='stylesheet' href='css/jquery-ui.css'>\n";
    $styles .= "<link rel='stylesheet' href='css/select2.min.css'>\n";
    $styles .= "<link rel='stylesheet' href='css/jquery.dataTables.css'>\n";
    $styles .= "<link rel='stylesheet' href='css/fossology.css'>\n";
    $styles .= "<link rel='icon' type='image/x-icon' href='favicon.ico'>\n";
    $styles .= "<link rel='shortcut icon' type='image/x-icon' href='favicon.ico'>\n";

    if ($this->NoMenu == 0) {
      $styles .= $this->menu->OutputCSS();
    }
    $this->vars['styles'] = $styles;

    if ($this->NoMenu == 0) {
      $this->vars['menu'] = $this->menu->Output($this->Title);
    }

    global $SysConf;
    $this->vars['versionInfo'] = array(
        'version' => $SysConf['BUILD']['VERSION'],
        'buildDate' => $SysConf['BUILD']['BUILD_DATE'],
        'commitHash' => $SysConf['BUILD']['COMMIT_HASH'],
        'commitDate' => $SysConf['BUILD']['COMMIT_DATE'],
        'branchName' => $SysConf['BUILD']['BRANCH']
    );

  } // OutputOpen()

  function OutputUnSet()
  {
    if ($this->State != PLUGIN_STATE_READY) {
      return 0;
    }
    return "";
  }

  function getResponse()
  {
    ob_start();
    $output = $this->Output();

    if ($output instanceof Response) {
      $response = $output;
    } else {
      if (empty($this->vars['content']) && $output) {
        $this->vars['content'] = $output;
      } elseif (empty($this->vars['content'])) {
        $this->vars['content'] = ob_get_contents();
      }
      $response = $this->render($this->getTemplateName());
    }
    ob_end_clean();

    return $response;
  }


  function Output()
  {
    return new Response("ERROR: Output() method of FO_Plugin not defined in class '" . get_class($this) . "'", Response::HTTP_INTERNAL_SERVER_ERROR);
  }

  public function getTemplateName()
  {
    return "include/base.html.twig";
  }

  public function renderString($templateName, $vars = null)
  {
    return $this->renderer->loadTemplate($templateName)->render($vars ?: $this->vars);
  }

  public function renderScripts($scripts)
  {
    $this->vars['scripts'] = $scripts;
  }

  protected function render($templateName, $vars = null)
  {
    $content = $this->renderString($templateName, $vars);

    return new Response(
        $content,
        Response::HTTP_OK,
        $this->headers
    );
  }

  public function getRequest()
  {
    if (!isset($this->request)) {
      $this->request = Request::createFromGlobals();
    }
    return $this->request;
  }

  public function execute()
  {
    $this->OutputOpen();
    $response = $this->getResponse();
    $response->prepare($this->getRequest());
    $response->send();
  }

  function preInstall()
  {
    if ($this->State == PLUGIN_STATE_VALID) {
      $this->PostInitialize();
    }
    if ($this->State == PLUGIN_STATE_READY) {
      $this->RegisterMenus();
    }
  }

  function postInstall()
  {
    $state = $this->Install();
    if ($state != 0) {
      throw new Exception("install of plugin " . $this->Name . " failed");
    }
  }

  function unInstall()
  {
    $this->Destroy();
  }

  public function getName()
  {
    return $this->Name;
  }

  function __toString()
  {
    return getStringRepresentation(get_object_vars($this), get_class($this));
  }
}