CopyrightLister.php

<?php
/***********************************************************
 Copyright (C) 2012 Hewlett-Packard Development Company, L.P.
 Copyright (C) 2014-2015 Siemens AG

 This library is free software; you can redistribute it and/or
 modify it under the terms of the GNU Lesser General Public
 License version 2.1 as published by the Free Software Foundation.

 This library 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
 Lesser General Public License for more details.

 You should have received a copy of the GNU Lesser General Public License
 along with this library; if not, write to the Free Software Foundation, Inc.0
 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
***********************************************************/

namespace Fossology\Lib\Util;

use Fossology\Lib\Dao\AgentDao;
use Fossology\Lib\Dao\CopyrightDao;
use Fossology\Lib\Dao\TreeDao;
use Fossology\Lib\Dao\UploadDao;
use Fossology\Lib\Db\DbManager;

class CopyrightLister
{
  private $dbManager;
  private $uploadDao;
  private $treeDao;
  private $copyrightDao;

  private $includeContainer = FALSE;
  private $excludingCopyright = -1;
  private $includingCopyright = -1;
  private $type = "";
  private $agentId;

  function __construct()
  {
    global $container;
    $this->dbManager = $container->get('db.manager');
    $this->uploadDao = $container->get('dao.upload');
    $this->treeDao = $container->get('dao.tree');
    $this->copyrightDao = $container->get('dao.copyright');
  }

  public function setContainerInclusion($includeContainer)
  {
    $this->includeContainer = $includeContainer;
  }

  public function setExcludingCopyright($excludingCopyright)
  {
    $this->excludingCopyright = $excludingCopyright;
  }

  public function setIncludingCopyright($includingCopyright)
  {
    $this->includingCopyright = $includingCopyright;
  }

  public function setType($type)
  {
    $this->type = $type;
  }

  public function getCopyrightList($itemId, $uploadId)
  {
    if (empty($itemId)) {
      $itemId = $this->uploadDao->getUploadParent($uploadId);
    }
    if (!$this->selectAgentId($uploadId)) {
      echo 'no valid copyright agent found';
      return;
    }
    $uploadtree_tablename = $this->uploadDao->getUploadtreeTableName($uploadId);
    $toprow = $this->uploadDao->getItemTreeBounds($itemId,$uploadtree_tablename);

    $extraWhere = 'agent_fk='.$this->agentId.' AND lft>'.$toprow->getLeft().' AND rgt<'.$toprow->getRight();
    $allCopyrightEntries = $this->copyrightDao->getAllEntries('copyright', $uploadId, $uploadtree_tablename,
            empty($this->type)||$this->type=='all' ? null : $this->type, false, null, $extraWhere);

    $modeMask = empty($this->includeContainer) ? (3<<28) : (1<<28);
    $sql = "SELECT uploadtree_pk, ufile_name, lft, rgt FROM $uploadtree_tablename
              WHERE upload_fk=$1 AND lft>$2 AND rgt<$3 AND (ufile_mode & $4) = 0
              ORDER BY uploadtree_pk";
    $this->dbManager->prepare($outerStmt=__METHOD__.'.loopThroughAllRecordsInTree',$sql);
    $outerresult = $this->dbManager->execute($outerStmt,array($toprow->getUploadId(),$toprow->getLeft(),$toprow->getRight(),$modeMask));
    while ($row = $this->dbManager->fetchArray($outerresult)) {
      $this->printRow($row,$uploadtree_tablename, $allCopyrightEntries); //$this->uploadDao->getParentItemBounds($uploadId)->getItemId());
    }
    $this->dbManager->freeResult($outerresult);
  }

  private function selectAgentId($uploadId)
  {
    global $container;
    /* @var $agentDao AgentDao */
    $agentDao = $container->get('dao.agent');
    $agentRec = $agentDao->agentARSList($tableName="copyright_ars", $uploadId, 1);

    if ($agentRec === false) {
      echo _("No data available \n");
      return false;
    }
    $this->agentId = $agentRec[0]["agent_fk"];
    return true;
  }

  private function printRow($row,$uploadtree_tablename, &$allCopyrightEntries, $parentId=0)
  {
    $filepath = $this->treeDao->getFullPath($row['uploadtree_pk'], $uploadtree_tablename, $parentId);

    $copyrightArray = array();
    foreach ($allCopyrightEntries as $entry) {
      if ($entry['uploadtree_pk'] == $row['uploadtree_pk']) {
        $copyrightArray[] = $entry['content'];
      }
    }
    $copyright = implode(', ', $copyrightArray);

    if (-1 != $this->includingCopyright && -1 != $this->excludingCopyright && !empty($this->includingCopyright) &&
        !empty($this->excludingCopyright)) {
      if (empty($copyright) || stristr($copyright, $this->includingCopyright) ||
          stristr($copyright, $this->excludingCopyright)) {
        return;
      }
    } else if (
          ! (-1 == $this->includingCopyright && -1 == $this->excludingCopyright) &&
          ! (empty($this->includingCopyright) && empty($this->excludingCopyright)) &&
          ! (empty($this->includingCopyright) && empty($copyright)) &&
          ! (empty($this->excludingCopyright) && !empty($copyright)) &&
          ! (-1 != $this->includingCopyright && !empty($this->includingCopyright) && !empty($copyright) && stristr($copyright, $this->includingCopyright)) &&
          ! (-1 != $this->excludingCopyright && !empty($this->excludingCopyright) && !empty($copyright) && !stristr($copyright, $this->excludingCopyright))) {
      return;
    }
    print ("$filepath: $copyright\n");
  }
}