AdminLicenseCandidate.php

<?php
/***********************************************************
 * 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.
 ***********************************************************/

namespace Fossology\UI\Page;

use Fossology\Lib\Auth\Auth;
use Fossology\Lib\BusinessRules\LicenseMap;
use Fossology\Lib\Dao\LicenseDao;
use Fossology\Lib\Dao\TreeDao;
use Fossology\Lib\Db\DbManager;
use Fossology\Lib\Plugin\DefaultPlugin;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\JsonResponse;
use Symfony\Component\HttpFoundation\Response;

class AdminLicenseCandidate extends DefaultPlugin
{
  const NAME = "admin_license_candidate";

  private $highlightProcessor;
  private $highlightRenderer;
  private $textRenderer;
  private $licenseDao;
  private $treeDao;


  function __construct()
  {
    parent::__construct(self::NAME, array(
        self::TITLE => "Admin License Candidates",
        self::MENU_LIST => "Admin::License Admin::Candidates",
        self::REQUIRES_LOGIN => true,
        self::PERMISSION => Auth::PERM_ADMIN
    ));

    $this->highlightProcessor = $this->getObject('view.highlight_processor');
    $this->highlightRenderer = $this->getObject('view.highlight_renderer');
    $this->textRenderer = $this->getObject('view.text_renderer');
    $this->licenseDao = $this->getObject('dao.license');
    $this->treeDao = $this->getObject('dao.tree');
  }

  protected function handle(Request $request)
  {

    $rf = intval($request->get('rf'));
    if ($rf<1) {
      $vars = array(
          'aaData' => json_encode($this->getArrayArrayData())
      );
      return $this->render('admin_license_candidate.html.twig', $this->mergeWithDefault($vars));
    }

    $vars = $this->getDataRow($rf);
    if ($vars === false) {
      throw new \Exception('invalid license candidate');
    }
    $shortname = $request->get('shortname') ?: $vars['rf_shortname'];
    $vars['shortname'] = $shortname;
    $rfText = $vars['rf_text'];
    $vars['rf_text'] = $rfText;

    $suggest = intval($request->get('suggest_rf'));
    $suggestLicense = false;
    if ($suggest>0) {
      $suggestLicense = $this->getDataRow($suggest, 'ONLY license_ref');
    }
    if (! $suggestLicense) {
      list ($suggestIds, $rendered) = $this->suggestLicenseId($rfText);
      if (! empty($suggestIds)) {
        $suggest = $suggestIds[0];
        $suggestLicense = $this->getDataRow($suggest, 'ONLY license_ref');
        $vars['rf_text'] = $rendered;
      }
    }
    if ($suggestLicense !== false) {
      $vars['suggest_rf'] = $suggest;
      $vars['suggest_shortname'] = $suggestLicense['rf_shortname'];
      $vars['suggest_fullname'] = $suggestLicense['rf_fullname'];
      $vars['suggest_text'] = $suggestLicense['rf_text'];
      $vars['suggest_url'] = $suggestLicense['rf_url'];
      $vars['suggest_notes'] = $suggestLicense['rf_notes'];
      $vars['suggest_risk'] = $suggestLicense['rf_risk'];
    }

    /* @var $licenseDao LicenseDao */
    $licenseDao = $this->getObject('dao.license');
    $vars['licenseArray'] = $licenseDao->getLicenseArray(0);
    $vars['scripts'] = js_url();

    $ok = true;
    switch ($request->get('do')) {
      case 'verify':
      case 'variant':
        $rfParent = ($request->get('do')=='verify') ? $rf : $suggest;
        try{
          $ok = $this->verifyCandidate($rf,$shortname,$rfParent);
        } catch (\Throwable $th) {
          $vars['message'] = 'The license text already exists.';
          break;
        }
        if ($ok) {
          $with = $rfParent ? '' : " as variant of <i>$vars[suggest_shortname]</i> ($rfParent)";
          $vars = array(
              'aaData' => json_encode($this->getArrayArrayData()),
              'message' => 'Successfully verified candidate '.$shortname.$with);
          return $this->render('admin_license_candidate.html.twig', $this->mergeWithDefault($vars));
        }
        $vars['message'] = 'Short name must be unique';
        break;
      case 'merge':
        try {
          $ok = $this->mergeCandidate($rf,$suggest,$vars);
        } catch (\Throwable $th) {
          $vars['message'] = 'The license text already exists.';
          break;
        }
        if ($ok) {
          $vars = array(
              'aaData' => json_encode($this->getArrayArrayData()),
              'message' => "Successfully merged candidate <i>$vars[suggest_shortname]</i> ($suggest) into <i>$vars[rf_shortname]</i> ($rf)");
          return $this->render('admin_license_candidate.html.twig', $this->mergeWithDefault($vars));
        }
        $vars['message'] = 'Sorry, this feature is not ready yet.';
        break;
      case 'deletecandidate':
        return $this->doDeleteCandidate($rf);
        break;
    }

    return $this->render('admin_license_candidate-merge.html.twig', $this->mergeWithDefault($vars));
  }

  private function getArrayArrayData()
  {
    $sql = "SELECT rf_pk,rf_shortname,rf_fullname,rf_text,group_name,group_pk "
            . "FROM license_candidate, groups "
            . "WHERE group_pk=group_fk AND marydone";
    /* @var $dbManager DbManager */
    $dbManager = $this->getObject('db.manager');
    $dbManager->prepare($stmt = __METHOD__, $sql);
    $res = $dbManager->execute($stmt);
    $aaData = array();
    $delete = "";
    while ($row = $dbManager->fetchArray($res)) {
      $link = Traceback_uri() . '?mod=' . self::NAME . '&rf=' . $row['rf_pk'];
      $edit = '<a href="' . $link . '"><img border="0" src="images/button_edit.png"></a>';
      $delete = '<img border="0" id="deletecandidate'.$row['rf_pk'].'" onClick="deleteCandidate('.$row['rf_pk'].')" src="images/icons/close_16.png">';

      $aaData[] = array($edit, htmlentities($row['rf_shortname']),
          htmlentities($row['rf_fullname']),
          '<div style="overflow-y:scroll;max-height:150px;margin:0;">' . nl2br(htmlentities($row['rf_text'])) . '</div>',
          htmlentities($row['group_name']),$delete
          );
    }
    $dbManager->freeResult($res);
    return $aaData;
  }


  private function getDataRow($licId,$table='license_candidate')
  {
    $sql = "SELECT rf_pk,rf_shortname,rf_fullname,rf_text,rf_url,rf_notes,rf_notes,rf_risk";
    if ($table == 'license_candidate') {
      $sql .= ',group_name,group_pk FROM license_candidate LEFT JOIN groups ON group_pk=group_fk '
              . 'WHERE rf_pk=$1 AND marydone';
    } else {
      $sql .= " FROM $table WHERE rf_pk=$1";
    }
    /* @var $dbManager DbManager */
    $dbManager = $this->getObject('db.manager');
    $row = $dbManager->getSingleRow($sql, array($licId), __METHOD__.".$table");
    return $row;
  }

  private function suggestLicenseId($str)
  {
    /* @var $monkOneShotPlugin \Fossology\Monk\UI\Oneshot */
    $monkOneShotPlugin = plugin_find("oneshot-monk");

    if (null !== $monkOneShotPlugin) {
      return $monkOneShotPlugin->scanMonkRendered($str);
    } else {
      return array(array(), $str);
    }
  }

  private function verifyCandidate($rf, $shortname, $rfParent)
  {
    /* @var $licenseDao LicenseDao */
    $licenseDao = $this->getObject('dao.license');
    if (!$licenseDao->isNewLicense($shortname, 0)) {
      return false;
    }

    /* @var $dbManager DbManager */
    $dbManager = $this->getObject('db.manager');
    $dbManager->begin();
    $dbManager->getSingleRow('INSERT INTO license_ref (rf_pk, rf_shortname, rf_text, rf_url, rf_add_date, rf_copyleft,
        "rf_OSIapproved", rf_fullname, "rf_FSFfree", "rf_GPLv2compatible", "rf_GPLv3compatible", rf_notes, "rf_Fedora",
        marydone, rf_active, rf_text_updatable, rf_md5 , rf_detector_type, rf_risk)
      (SELECT rf_pk, $2 as rf_shortname, rf_text, rf_url, now() as rf_add_date, rf_copyleft,
        "rf_OSIapproved", rf_fullname, "rf_FSFfree", "rf_GPLv2compatible", "rf_GPLv3compatible", rf_notes, "rf_Fedora",
        false AS marydone, rf_active, rf_text_updatable, md5(rf_text) rf_md5 , 1 rf_detector_type, rf_risk
  FROM license_candidate WHERE rf_pk=$1)',array($rf,$shortname),__METHOD__.'.insert');
    $dbManager->insertTableRow('license_map',array('rf_fk'=>$rf,'rf_parent'=>$rfParent,'usage'=>LicenseMap::CONCLUSION));
    $dbManager->getSingleRow('DELETE FROM license_candidate WHERE rf_pk=$1',array($rf),__METHOD__.'.delete');
    $dbManager->commit();
    return true;
  }

  private function mergeCandidate($candidate, $suggest, $vars)
  {
    $dbManager = $this->getObject('db.manager');
    $tableColumnMap = array("license_file"=>"rf_fk",
        "license_set_bulk"=>"rf_fk",
        "clearing_event"=>"rf_fk");
    foreach ($tableColumnMap as $table=>$column) {
      $dbManager->prepare($stmt=__METHOD__.".$table","UPDATE $table SET $column=$1 WHERE $column=$2");
      $dbManager->freeResult( $dbManager->execute($stmt,array($suggest,$candidate)) );
    }
    $updates = array();
    if (empty($vars['suggest_url']) && $vars['rf_url']) {
      $updates[$vars['rf_url']] = 'rf_url=$' . (count($updates)+1);
    }
    if (!$vars['rf_notes']) {
      $updates[$vars['suggest_notes']."\n".$vars['rf_notes']] = 'rf_notes=$' . (count($updates)+1);
    }
    if (count($updates)) {
      $sql = 'UPDATE license_ref SET '.implode(',', $updates).' WHERE rf_pk=$'.(count($updates)+1);
      $dbManager->prepare($stmt=__METHOD__.'.update',$sql);
      $params = array_keys($updates);
      $params[] = $suggest;
      $dbManager->freeResult( $dbManager->execute($stmt,$params) );
    }
    $dbManager->prepare($stmt=__METHOD__.'.delete','DELETE FROM license_candidate WHERE rf_pk=$1');
    $dbManager->freeResult( $dbManager->execute($stmt,array($candidate)) );
    return true;
  }

  protected function doDeleteCandidate($rfPk)
  {
    $dbManager = $this->getObject('db.manager');
    $stmt = __METHOD__.".getUploadtreeFkForUsedCandidates";
    $dbManager->prepare($stmt, "SELECT uploadtree_fk
                                  FROM clearing_event
                                 WHERE removed=false
                                   AND date_added IN(SELECT max(date_added)
                                                       FROM clearing_event
                                                      WHERE rf_fk=$1
                                                       GROUP BY uploadtree_fk)");
    $result = $dbManager->execute($stmt, array($rfPk));
    $dataFetch = $dbManager->fetchAll($result);
    $dbManager->freeResult($result);
    if (empty($dataFetch)) {
      $dbManager->getSingleRow('DELETE FROM license_candidate WHERE rf_pk=$1', array($rfPk), __METHOD__.".delete");
      return new Response('true', Response::HTTP_OK, array('Content-type'=>'text/plain'));
    } else {
      $treeDao = $this->getObject('dao.tree');
      $message = "<div class='candidateFileList'><ol>";
      foreach ($dataFetch as $cnt => $uploadTreeFk) {
        $message .= "<li>".$treeDao->getFullPath($uploadTreeFk['uploadtree_fk'], 'uploadtree')."</li>";
      }
      $message .= "</ol></div>";
      return new Response($message, Response::HTTP_OK, array('Content-type'=>'text/plain'));
    }
  }
}

register_plugin(new AdminLicenseCandidate());