Merge pull request coral-erm#488 from queryluke/terms-tool

Adds Terms tool code into Coral

.gitignore

@@ -13,3 +13,6 @@ tests/_support/_generated/
 
 # Workspace directory for IDE
 /.idea
+
+# Custom terms tool branding
+licensing/css/custom.css

common/safe_file_rewrite.php

@@ -0,0 +1,38 @@
+<?php
+
+
+if (!function_exists('safe_file_rewrite')) {
+    /**
+     * Safely rewrites a file
+     *
+     * @param string $fileName A path to a file
+     *
+     * @param string $dataToSave the string to rewrite the file
+     */
+    function safe_file_rewrite($fileName, $dataToSave)
+    {
+        if (!is_writable($fileName)) {
+            throw new Exception("$fileName is not writeable.");
+        }
+
+        if ($fp = fopen($fileName, 'w')) {
+            $startTime = microtime(TRUE);
+
+            do {
+                $canWrite = flock($fp, LOCK_EX);
+                // If lock not obtained sleep for 0 - 100 milliseconds, to avoid collision and CPU load
+                if (!$canWrite) {
+                    usleep(round(rand(0, 100) * 1000));
+                }
+            } while ((!$canWrite) and ((microtime(TRUE) - $startTime) < 5));
+
+            //file was locked so now we can store information
+            if ($canWrite) {
+                fwrite($fp, $dataToSave);
+                flock($fp, LOCK_UN);
+            }
+            fclose($fp);
+        }
+    }
+
+}

common/write_php_ini.php

@@ -0,0 +1,29 @@
+<?php
+
+require_once 'safe_file_rewrite.php';
+
+if (!function_exists('write_php_ini')) {
+    /**
+     * Safely writes to a .ini file from an array
+     *
+     * @param string $file A path to a .ini file
+     *
+     * @param array $array The array to write as a .ini file
+     *                         integer key of the column you wish to retrieve, or it
+     *                         may be the string key name for an associative array.
+     */
+    function write_php_ini($file, $array)
+    {
+        $res = array();
+        foreach($array as $key => $val)
+        {
+            if(is_array($val))
+            {
+                $res[] = "[$key]";
+                foreach($val as $skey => $sval) $res[] = "$skey = ".(is_numeric($sval) ? $sval : '"'.addcslashes($sval, '"').'"');
+            }
+            else $res[] = "$key = ".(is_numeric($val) ? $val : '"'.addcslashes($val, '"').'"');
+        }
+        safe_file_rewrite($file, implode("\r\n", $res));
+    }
+}

licensing/admin.php

@@ -170,6 +170,28 @@
 
 <?php } ?>
 
+<?php
+
+//if the Terms Tool is used, display options
+if ($config->settings->useTermsToolFunctionality == 'Y') { ?>
+
+    <br />
+    <br />
+
+    <table class="headerTable">
+        <tr><td>
+                <span class="headerText"><?php echo _("Terms Tool Settings");?></span>&nbsp;&nbsp;<span id='span_TermsTool_response'></span>
+                <br /><a href="ajax_forms.php?action=getTermsToolSettingsForm&height=158&width=265&modal=true" class="thickbox"><?php echo _("edit"); ?></a>
+                <br />
+                <br />
+                <div id='div_TermsTool'>
+                    <img src = "images/circle.gif"><?php echo _("Loading...");?>
+                </div>
+            </td></tr>
+    </table>
+
+<?php } ?>
+
 <br />
 
 <script type="text/javascript" src="js/admin.js"></script>

licensing/admin/classes/domain/EBSCOService.php

@@ -0,0 +1,114 @@
+<?php
+/*
+**************************************************************************************************************************
+** CORAL Licensing Module Terms Tool Add-On v. 1.0
+**
+** Copyright (c) 2010 University of Notre Dame
+**
+** This file is part of CORAL.
+**
+** CORAL is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
+**
+** CORAL 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 CORAL.  If not, see <http://www.gnu.org/licenses/>.
+**
+**************************************************************************************************************************
+*/
+
+
+
+class EBSCOService extends Base_Object {
+
+	protected $issn;
+	protected $isbn;
+	protected $config;
+	protected $error;
+	protected $open_url;
+	protected $object_title;
+
+	protected function init(NamedArguments $arguments) {
+		parent::init($arguments);
+		$this->issn = $arguments->issn;
+		$this->isbn = $arguments->isbn;
+		$this->config = new Configuration;
+
+		//determine the full open URL
+		//get the ISBN or ISSN passed in
+		if ($this->isbn){
+			$stringAppend = $this->isbn;
+		}else{
+			$stringAppend = $this->issn;
+		}
+
+        //get the client identifier out of the config terms
+        $client_identifier = $this->config->terms->client_identifier;
+
+		$this->open_url = "https://api.ebsco.io/rm/rmaccounts/" . $client_identifier . "/titles?search=" . $stringAppend . "&searchfield=isxn&selection=selected&orderby=relevance&count=5&offset=1";
+	}
+
+
+	public function getTargets() {
+        $ch = curl_init();
+        curl_setopt($ch, CURLOPT_URL,$this->open_url);
+        curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
+        curl_setopt($ch, CURLOPT_HTTPHEADER, [
+            'Accept: application/json',
+            'x-api-key: '.$this->config->terms->sid,
+        ]);
+
+		//Make the call to EBSCO KB and load results
+        $response = curl_exec($ch);
+        curl_close ($ch);
+
+		$responseArray = json_decode($response, true);
+
+		//get the title of the resource to use in getTitle()
+		$this->object_title = $responseArray['titles'][0]['titleName'];
+
+		$targetArray = array();
+
+		//get the package name and URL for all packages and put into target array
+		foreach($responseArray['titles'] as $title) {
+			foreach($title['customerResourcesList'] as $package)
+				if ($package['url']) {
+					$targetArray[] = array(
+						'public_name' => $package['packageName'],
+						'target_url' => $package['url']
+					);
+				}
+		}
+
+		return $targetArray;
+	}
+
+
+	public function getTitle() {
+
+		//get title for object from variable
+		$title = $this->object_title;
+
+		//alternatively like SFX and SerialsSolutions: make a new call to EBSCO KB and load results
+		/*
+        $ch = curl_init();
+        curl_setopt($ch, CURLOPT_URL,$this->open_url);
+        curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
+        curl_setopt($ch, CURLOPT_HTTPHEADER, [
+            'Accept: application/json',
+            'x-api-key: '.$this->config->terms->sid,
+        ]);
+
+        $response = curl_exec($ch);
+        curl_close ($ch);
+
+		$responseArray = json_decode($response, true);
+
+		$title = $responseArray['titles'][0]['titleName'];
+		*/
+
+		return $title;
+	}
+
+}
+
+?>

licensing/admin/classes/domain/Expression.php

@@ -127,7 +127,21 @@ public function removeQualifiers(){
 
 
 
+	//returns most recent update date for this expression
+    public function getLastUpdateDate(){
 
+        $query = "SELECT date_format(MAX(updateDate), '%m/%d/%Y') lastUpdateDate FROM (
+					SELECT MAX(lastUpdateDate) updateDate
+						FROM Expression WHERE expressionID='" . $this->expressionID . "'
+					UNION
+					SELECT MAX(lastUpdateDate) updateDate
+						FROM ExpressionNote WHERE expressionID='" . $this->expressionID . "') allDates;";
+
+        $result = $this->db->processQuery($query, 'assoc');
+
+        return $result['lastUpdateDate'];
+
+    }
 
 
 

licensing/admin/classes/domain/ExpressionType.php

@@ -175,8 +175,103 @@ public function removeExpressionType(){
 
 
 
+    public function reorderTargets($targetsArray){
+        $topTargetArray = array();
+        $bottomTargetArray = array();
+        $reorderedArray = array();
 
+        $targetArray = array();
+        foreach ($targetsArray as $i => $targetArray){
+            if (count($this->getExpressionsByResource($targetArray['public_name'])) > 0){
+                array_push($topTargetArray, $targetArray);
+            }else{
+                array_push($bottomTargetArray, $targetArray);
+            }
+        }
 
+        $targetArray = array();
+        foreach ($topTargetArray as $targetArray){
+            array_push($reorderedArray, $targetArray);
+        }
+
+
+        foreach ($bottomTargetArray as $targetArray){
+            array_push($reorderedArray, $targetArray);
+        }
+
+        return $reorderedArray;
+
+    }
+
+
+
+
+
+	//returns array of expression objects
+    public function getExpressionsByResource($resourceName){
+
+        $query = ("SELECT E.expressionID
+					FROM Document D, SFXProvider SP, Expression E
+					WHERE D.documentID = E.documentID
+					AND (D.expirationDate is null || D.expirationDate = '0000-00-00')
+					AND SP.documentID = D.documentID
+					AND E.productionUseInd='1'
+					AND E.expressionTypeID = '" . $this->expressionTypeID . "'
+					AND SP.shortName = '" . $resourceName . "';");
+
+
+        $result = $this->db->processQuery($query, 'assoc');
+
+        $objects = array();
+
+        //need to do this since it could be that there's only one request and this is how the dbservice returns result
+        if (isset($result['expressionID'])){
+            $object = new Expression(new NamedArguments(array('primaryKey' => $result['expressionID'])));
+            array_push($objects, $object);
+        }else{
+            foreach ($result as $row) {
+                $object = new Expression(new NamedArguments(array('primaryKey' => $row['expressionID'])));
+                array_push($objects, $object);
+            }
+        }
+
+        return $objects;
+    }
+
+
+
+
+
+
+    //returns array of expression type ids
+    public function getExpressionTypesByResource($resourceName){
+
+        $query = ("SELECT distinct E.expressionTypeID
+					FROM Document D, SFXProvider SP, Expression E, ExpressionType ET
+					WHERE D.documentID = E.documentID
+					AND (D.expirationDate is null || D.expirationDate = '0000-00-00')
+					AND SP.documentID = D.documentID
+					AND E.productionUseInd='1'
+					AND ET.expressionTypeID = E.expressionTypeID
+					AND SP.shortName = '" . $resourceName . "'
+					ORDER BY ET.shortName;");
+
+
+        $result = $this->db->processQuery($query, 'assoc');
+
+        $expressionTypeArray = array();
+
+        //need to do this since it could be that there's only one result and this is how the dbservice returns result
+        if (isset($result['expressionTypeID'])){
+            $expressionTypeArray[] = $result['expressionTypeID'];
+        }else{
+            foreach ($result as $row) {
+                $expressionTypeArray[] = $row['expressionTypeID'];
+            }
+        }
+
+        return $expressionTypeArray;
+    }
 
 
 }