Import licenses from CSV. More...

Collaboration diagram for Fossology\Lib\Application\LicenseCsvImport:

Public Member Functions
	__construct (DbManager $dbManager, UserDao $userDao, $obligationMap=null)

	setDelimiter ($delimiter=',')
	Update the delimiter. More...

	setEnclosure ($enclosure='"')
	Update the enclosure. More...

	handleFile ($filename, $fileExtension)
	Read the CSV line by line and import it. More...

	handleRowJson ($row)

	importJsonData ($data, string $msg)

Protected Attributes
	$dbManager

	$userDao

	$delimiter = ','

	$enclosure = '"'

	$headrow = null

	$nkMap = array()

	$mdkMap = array()

	$alias

	$obligationMap

Private Member Functions
	handleCsv ($row)

	handleJsonLicense ($row)

	handleHeadCsv ($row)
	Handle a row as head row. More...

	updateLicense ($row, $rfPk)
	Update the license info in the DB. More...

	handleCsvLicense ($row)
	Handle a single row from CSV. More...

	handleLicenseDBLicenseImport ($row)
	Handle a single row from csv import form LicenseDB. More...

	insertMapIfNontrivial ($fromName, $toName, $usage)
	Insert in `license_map` table if the license conclusion is non-trivial. More...

	getKeyFromShortname ($shortname, $groupFk=null)
	Get the license id using license shortname from DB or nkMap. More...

	getKeyFromMd5 ($licenseText)

	setMap ($from, $to, $usage)
	Update license mappings. More...

	insertNewLicense ($row, $tableName="license_ref")
	Insert a new license in DB. More...

Detailed Description

Import licenses from CSV.

Definition at line 25 of file LicenseCsvImport.php.

Constructor & Destructor Documentation

◆ __construct()

Fossology\Lib\Application\LicenseCsvImport::__construct	(	DbManager	$dbManager,
		UserDao	$userDao,
			$obligationMap = `null`
	)

Constructor

Parameters

DbManager	$dbManager	DB manager to use
UserDao	$userDao	User Dao to use

Definition at line 76 of file LicenseCsvImport.php.

Member Function Documentation

◆ getKeyFromMd5()

Fossology\Lib\Application\LicenseCsvImport::getKeyFromMd5 ( $licenseText )

private

Get the license id using license text's checksum from DB or mdkMap.

Parameters

string $licenseText License text

Returns: integer License id

Definition at line 564 of file LicenseCsvImport.php.

◆ getKeyFromShortname()

Fossology\Lib\Application\LicenseCsvImport::getKeyFromShortname	(	$shortname,
		$groupFk = `null`
	)

private

Get the license id using license shortname from DB or nkMap.

Parameters

string $shortname Shortname of the license.

Returns: int License id

Definition at line 534 of file LicenseCsvImport.php.

◆ handleCsv()

Fossology\Lib\Application\LicenseCsvImport::handleCsv ( $row )

private

Handle a single row read from the CSV. If headrow is not set, then handle current row as head row.

Parameters

array $row Single row from CSV

Returns: string $log Log messages

Definition at line 183 of file LicenseCsvImport.php.

◆ handleCsvLicense()

Fossology\Lib\Application\LicenseCsvImport::handleCsvLicense ( $row )

private

Handle a single row from CSV.

The function checks if the license text hash is already in the DB, then updates it. Otherwise inserts new row in the DB.

Parameters

array $row CSV row to be inserted.

Returns: string Log messages.

Definition at line 383 of file LicenseCsvImport.php.

◆ handleFile()

Fossology\Lib\Application\LicenseCsvImport::handleFile	(	$filename,
		$fileExtension
	)

Read the CSV line by line and import it.

Parameters

string $filename Location of the CSV file.

Returns: string message Error message, if any. Otherwise Read csv: <count> licenses on success.

Definition at line 106 of file LicenseCsvImport.php.

◆ handleHeadCsv()

Fossology\Lib\Application\LicenseCsvImport::handleHeadCsv ( $row )

private

Handle a row as head row.

Parameters

array $row Head row to be handled.

Exceptions

Definition at line 235 of file LicenseCsvImport.php.

◆ handleJsonLicense()

Fossology\Lib\Application\LicenseCsvImport::handleJsonLicense ( $row )

private

Handle a single row read from JSON and normalize optional values before importing from LicenseDB.

Parameters

array $row Single row from JSON

Returns: string $log Log messages

Definition at line 213 of file LicenseCsvImport.php.

◆ handleLicenseDBLicenseImport()

Fossology\Lib\Application\LicenseCsvImport::handleLicenseDBLicenseImport ( $row )

private

Handle a single row from csv import form LicenseDB.

The function checks for license with the row's licensedb id in the license_ref table. If found, updates it with the row's content and if not, creates a new one.

It also creates the license obligation maps with the obligations that are found in the obligation_ref table.

Parameters

array $row CSV row to be inserted.

Returns: string Log messages.

Definition at line 430 of file LicenseCsvImport.php.

◆ handleRowJson()

Fossology\Lib\Application\LicenseCsvImport::handleRowJson ( $row )

Handle a single row read from the JSON. If the key matches values from alias array then replace it with key

Parameters

array $row

Returns: array $newArray

Definition at line 146 of file LicenseCsvImport.php.

◆ importJsonData()

Fossology\Lib\Application\LicenseCsvImport::importJsonData	(		$data,
		string	$msg
	)

Parameters

	$data
string	$msg

Returns: string

Definition at line 683 of file LicenseCsvImport.php.

◆ insertMapIfNontrivial()

Fossology\Lib\Application\LicenseCsvImport::insertMapIfNontrivial	(	$fromName,
		$toName,
		$usage
	)

private

Insert in license_map table if the license conclusion is non-trivial.

If the from and to are not same and from exists in database, then the conclusion is non-trivial.

Parameters

string	$fromName	Parent license name
string	$toName	License name
string	$usage	Usage of the license

Returns: boolean True if license is non-trivial, false otherwise.

Definition at line 517 of file LicenseCsvImport.php.

◆ insertNewLicense()

Fossology\Lib\Application\LicenseCsvImport::insertNewLicense	(	$row,
		$tableName = `"license_ref"`
	)

private

Insert a new license in DB.

Creates a new main license/candidate license based on table name sent and if the required group exists in DB.

Parameters

array	$row	Rows comming from CSV
string	$tableName	Table where this new license should go to

Returns: string Log messages

Definition at line 622 of file LicenseCsvImport.php.

◆ setDelimiter()

Fossology\Lib\Application\LicenseCsvImport::setDelimiter ( $delimiter = ',' )

Update the delimiter.

Parameters

string $delimiter New delimiter to use.

Definition at line 86 of file LicenseCsvImport.php.

◆ setEnclosure()

Fossology\Lib\Application\LicenseCsvImport::setEnclosure ( $enclosure = '"' )

Update the enclosure.

Parameters

string $enclosure New enclosure to use.

Definition at line 95 of file LicenseCsvImport.php.

◆ setMap()

Fossology\Lib\Application\LicenseCsvImport::setMap	(	$from,
		$to,
		$usage
	)

private

Update license mappings.

First check if the mapping already exists for the license, then update it. If the mapping does not exists, then insert it.

Parameters

integer	$from	The new mapping license
integer	$to	The license to be updated
integer	$usage	The usage

Returns: boolean False if mapping could not be updated or $from is empty.

Definition at line 587 of file LicenseCsvImport.php.

◆ updateLicense()

Fossology\Lib\Application\LicenseCsvImport::updateLicense	(	$row,
		$rfPk
	)

private

Update the license info in the DB.

Parameters

array	$row	Row with new values.
int	$rfPk	Matched license ID.

Returns: string Log messages.

Definition at line 259 of file LicenseCsvImport.php.

Member Data Documentation

◆ $alias

array Fossology\Lib\Application\LicenseCsvImport::$alias

protected

Initial value:

= array(
      'shortname'=>array('shortname','Short Name'),
      'licensetype'=>array('licensetype','License Type'),
      'fullname'=>array('fullname','Long Name'),
      'spdx_id'=>array('spdx_id', 'SPDX ID'),
      'text'=>array('text','Full Text'),
      'parent_shortname'=>array('parent_shortname','Decider Short Name'),
      'report_shortname'=>array('report_shortname','Regular License Text Short Name'),
      'url'=>array('url','URL'),
      'notes'=>array('notes'),
      'source'=>array('source','Foreign ID'),
      'risk'=>array('risk','risk_level'),
      'group'=>array('group','License group'),
      'obligations'=>array('obligations','License obligations'),
      'external_id'=>array('id','LicenseDB Id'),
      )

Alias for headers

Definition at line 50 of file LicenseCsvImport.php.

◆ $dbManager

DbManager Fossology\Lib\Application\LicenseCsvImport::$dbManager

protected

DB manager to use

Definition at line 29 of file LicenseCsvImport.php.

◆ $delimiter

string Fossology\Lib\Application\LicenseCsvImport::$delimiter = ','

protected

Delimiter used in CSV

Definition at line 35 of file LicenseCsvImport.php.

◆ $enclosure

string Fossology\Lib\Application\LicenseCsvImport::$enclosure = '"'

protected

Enclosure used in CSV

Definition at line 38 of file LicenseCsvImport.php.

◆ $headrow

null array Fossology\Lib\Application\LicenseCsvImport::$headrow = null

protected

Header of CSV

Definition at line 41 of file LicenseCsvImport.php.

◆ $mdkMap

array Fossology\Lib\Application\LicenseCsvImport::$mdkMap = array()

protected

Map based on license text MD5

Definition at line 47 of file LicenseCsvImport.php.

◆ $nkMap

array Fossology\Lib\Application\LicenseCsvImport::$nkMap = array()

protected

Map based on license shortname

Definition at line 44 of file LicenseCsvImport.php.

◆ $obligationMap

ObligationMap Fossology\Lib\Application\LicenseCsvImport::$obligationMap

protected

obligation map to use

Definition at line 69 of file LicenseCsvImport.php.

◆ $userDao

UserDao Fossology\Lib\Application\LicenseCsvImport::$userDao

protected

User DAO to use

Definition at line 32 of file LicenseCsvImport.php.

The documentation for this class was generated from the following file:

src/lib/php/Application/LicenseCsvImport.php

Public Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getKeyFromMd5()

◆ getKeyFromShortname()

◆ handleCsv()

◆ handleCsvLicense()

◆ handleFile()

◆ handleHeadCsv()

◆ handleJsonLicense()

◆ handleLicenseDBLicenseImport()

◆ handleRowJson()

◆ importJsonData()

◆ insertMapIfNontrivial()

◆ insertNewLicense()

◆ setDelimiter()

◆ setEnclosure()

◆ setMap()

◆ updateLicense()

Member Data Documentation

◆ $alias

◆ $dbManager

◆ $delimiter

◆ $enclosure

◆ $headrow

◆ $mdkMap

◆ $nkMap

◆ $obligationMap

◆ $userDao