oneshot.php

<?php
/***********************************************************
 Copyright (C) 2010-2014 Hewlett-Packard Development Company, L.P.

 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\Data\Highlight;
use Fossology\Lib\Auth\Auth;
define("TITLE_AGENT_COPYRIGHT_ONCE", _("One-Shot Copyright/Email/URL Analysis"));

class agent_copyright_once extends FO_Plugin {

  function __construct()
  {
    $this->Name = "agent_copyright_once";
    $this->Title = TITLE_AGENT_COPYRIGHT_ONCE;
    $this->Version = "1.0";
    //$this->Dependency = array("browse", "view");
    $this->DBaccess = PLUGIN_DB_NONE;
    $this->LoginFlag = 0;
    $this->NoMenu = 0;
    $this->NoHTML = 0;

    parent::__construct();

    global $container;
    $this->uploadDao = $container->get('dao.upload');
    $this->copyrightDao = $container->get('dao.copyright');
  }

  function AnalyzeOne() {
    global $Plugins;
    global $SYSCONFDIR;
    $ModBack = GetParm("modback",PARM_STRING);
    $copyright_array = array();
    $V = "";

    $view = & $Plugins[plugin_find_id("view") ];
    $tempFileName = $_FILES['licfile']['tmp_name'];
    $ui_dir = getcwd();
    $copyright_dir =  "$SYSCONFDIR/mods-enabled/copyright/agent/";
    if(!chdir($copyright_dir)) {
      $errmsg = _("unable to change working directory to $copyright_dir\n");
      return $errmsg;
    }
    //$Sys = "./copyright -C $tempFileName -c $SYSCONFDIR";
    $Sys = "./copyright -c $SYSCONFDIR $tempFileName";

    $inputFile = popen($Sys, "r");
    $colors = array();
    $colors['statement'] = 0;
    $colors['email'] = 1;
    $colors['url'] = 2;
    $stuff = array();
    $stuff['statement'] = array();
    $stuff['email'] = array();
    $stuff['url'] = array();
    $realline = "";

    $highlights = array();

    $typeToHighlightTypeMap = array(
        'statement' => Highlight::COPYRIGHT,
        'email' => Highlight::EMAIL,
        'url' => Highlight::URL);
    while (!feof($inputFile)) {
      $Line = fgets($inputFile);
      if ($Line[0] == '/') { continue;
      }
      $count = strlen($Line);
      if ($count > 0) {
        if ((($count > 1) && ("'" != $Line[$count - 2])) || ((1 == $count) && ("'" != $Line[$count - 1])))
        {
          $Line = str_replace("\n", ' ', $Line); // in order to preg_match_all correctly, replace NL with white space
          $realline .= $Line;
          continue;
        }
        $realline .= $Line;
        //print "<br>realline$realline<br>";
        $match = array();
        preg_match_all("/\t\[(?P<start>\d+)\:(?P<end>\d+)\:(?P<type>[A-Za-z]+)\] \'(?P<content>.+)\'/", $realline, $match);
        //print_r($match);
        if (!empty($match['start'])) {
          $stuff[$match['type'][0]][] = $match['content'][0];
          if ($this->NoHTML) { // For REST API
            array_push($copyright_array, $match['content'][0]);
          } else {
            $highlights[] = new Highlight($match['start'][0], $match['end'][0], $typeToHighlightTypeMap[$match['type'][0]], -1, -1, $match['content'][0]);
          }
        }
      }
      $realline = "";
    }
    pclose($inputFile);

    if ($this->NoHTML) // For REST API:
    {
      return $copyright_array;
    }

    $inputFile = fopen($tempFileName, "r");
    if ($inputFile) {
      $V = $view->getView($inputFile, $ModBack, 0, NULL, $highlights); // do not show Header and micro menus
      fclose($inputFile);
    }
    if(!chdir($ui_dir)) {
      $errmsg = _("unable to change back to working directory $ui_dir\n");
      return $errmsg;
    }
    /* Clean up */
    return ($V);
  } // AnalyzeOne()

  function RegisterMenus() {
    if ($this->State != PLUGIN_STATE_READY) {
      return (0);
    } // don't run
    $Highlight = GetParm('highlight', PARM_INTEGER);
    if (empty($Hightlight)) {
      $Highlight = 0;
    }
    $ShowHeader = GetParm('showheader', PARM_INTEGER);
    if (empty($ShowHeader)) {
      $ShowHeader = 0;
    }
    if (GetParm("mod", PARM_STRING) == $this->Name) {
      $ThisMod = 1;
    }
    else {
      $ThisMod = 0;
    }
    /* Check for a wget post (wget cannot post to a variable name) */
    if ($ThisMod && empty($_POST['licfile'])) {
      $Fin = fopen("php://input", "r");
      $Ftmp = tempnam(NULL, "fosslic-alo-");
      $Fout = fopen($Ftmp, "w");
      while (!feof($Fin)) {
        $Line = fgets($Fin);
        fwrite($Fout, $Line);
      }
      fclose($Fout);
      if (filesize($Ftmp) > 0) {
        $_FILES['licfile']['tmp_name'] = $Ftmp;
        $_FILES['licfile']['size'] = filesize($Ftmp);
        $_FILES['licfile']['unlink_flag'] = 1;
      }
      else {
        unlink($Ftmp);
      }
      fclose($Fin);
    }
    if ($ThisMod && file_exists(@$_FILES['licfile']['tmp_name']) && ($Highlight != 1) && ($ShowHeader != 1)) {
      $this->NoHTML = 1;
      /* default header is plain text */
    }
    /* Only register with the menu system if the user is logged in. */
    if (!empty($_SESSION[Auth::USER_NAME]))
    {
      // Debugging changes to license analysis NOTE: this comment doesn't make sense.
      if ($_SESSION[Auth::USER_LEVEL] >= PLUGIN_DB_WRITE)
      {
        menu_insert("Main::Upload::One-Shot Copyright/Email/URL", $this->MenuOrder, $this->Name, $this->MenuTarget);

        $tooltipText = _("Copyright/Email/URL One-shot, real-time analysis");
        $menuText = "One-Shot Copyright/Email/URL";
        $menuPosition = 100;
        menu_insert("View::[BREAK]", $menuPosition);
        menu_insert("View::{$menuText}", $menuPosition + 1, $this->Name, $tooltipText);
        menu_insert("View-Meta::[BREAK]", $menuPosition);
        menu_insert("View-Meta::{$menuText}", $menuPosition + 1, $this->Name, $tooltipText);
      }
    }
  } // RegisterMenus()

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

    /* For REST API:
       wget -qO - --post-file=myfile.c http://myserv.com/?mod=agent_copyright_once
    */

    $tmp_name = '';
    if (array_key_exists('licfile', $_FILES) && array_key_exists('tmp_name', $_FILES['licfile']))
    {
      $tmp_name = $_FILES['licfile']['tmp_name'];
    }

    $this->vars['styles'] .= "<link rel='stylesheet' href='css/highlights.css'>\n";
    if ($this->OutputType!='HTML' && file_exists($tmp_name))
    {
      $copyright_res = $this->AnalyzeOne();
      $cont = '';
      foreach ($copyright_res as $copyright)
      {
        $cont = "$copyright\n";
      }
      unlink($tmp_name);
      return $cont;
    }

    if ($this->OutputType=='HTML') {
      /* If this is a POST, then process the request. */
      if ($tmp_name) {
        if ($_FILES['licfile']['size'] <= 1024 * 1024 * 10) {
          $this->vars['content'] = $this->AnalyzeOne();
        }
        else {
          $this->vars['message'] =  _('file is to large for one-shot copyright analyze');
        }
        return;
      }
      $this->vars['content'] = $this->htmlContent();
    }
    if (array_key_exists('licfile', $_FILES) && array_key_exists('unlink_flag',$_FILES['licfile'])) {
      unlink($tmp_name);
    }
    // $_FILES['licfile'] = NULL;
  }

  protected function htmlContent()
  {
    $V = _("This analyzer allows you to upload a single file for copyright/email/url analysis.\n");
    $V.= "<ul>\n";
    $V.= "<li>" . _("The analysis is done in real-time.");
    $V.= "<li>" . _("Files that contain files are <b>not</b> unpacked. If you upload a container like a gzip file, then only that binary file will be scanned.\n");
    $V.= "<li>" . _("Results are <b>not</b> stored. As soon as you get your results, your uploaded file is removed from the system.\n");
    $V.= "</ul>\n";
    /* Display the form */
    $V.= "<form enctype='multipart/form-data' method='post'>\n";
    $V.= _("Select the file to upload:");
    $V.= "<br><input name='licfile' size='60' type='file' /><br />\n";
    $V.= "<input type='hidden' name='showheader' value='1'>";

    $text = _("Upload and scan");
    $V.= "<p><input type='submit' value='$text'>\n";
    $V.= "</form>\n";
    return $V;
  }
}

$NewPlugin = new agent_copyright_once();