<?php

/**
 * @defgroup subscription Subscription
 * Implement subscriptions, subscription management, and subscription checking.
 */
 
/**
 * @file classes/subscription/InstitutionalSubscription.inc.php
 *
 * Copyright (c) 2014-2021 Simon Fraser University
 * Copyright (c) 2003-2021 John Willinsky
 * Distributed under the GNU GPL v3. For full terms see the file docs/COPYING.
 *
 * @class InstitutionalSubscription
 * @ingroup subscription 
 * @see InstitutionalSubscriptionDAO
 *
 * @brief Basic class describing an institutional subscription.
 */

import('classes.subscription.Subscription');

define('SUBSCRIPTION_IP_RANGE_RANGE', '-');
define('SUBSCRIPTION_IP_RANGE_WILDCARD', '*');


class InstitutionalSubscription extends Subscription {

	//
	// Get/set methods
	//

	/**
	 * Get the institution name of the institutionalSubscription.
	 * @return string 
	 */
	function getInstitutionName() {
		return $this->getData('institutionName');
	}

	/**
	 * Set the institution name of the institutionalSubscription.
	 * @param $institutionName string
	 */
	function setInstitutionName($institutionName) {
		return $this->setData('institutionName', $institutionName);
	}

	/**
	 * Get the mailing address of the institutionalSubscription.
	 * @return string 
	 */
	function getInstitutionMailingAddress() {
		return $this->getData('mailingAddress');
	}

	/**
	 * Set the mailing address of the institutionalSubscription.
	 * @param $mailingAddress string
	 */
	function setInstitutionMailingAddress($mailingAddress) {
		return $this->setData('mailingAddress', $mailingAddress);
	}

	/**
	 * Get institutionalSubscription domain string.
	 * @return string
	 */
	function getDomain() {
		return $this->getData('domain');
	}

	/**
	 * Set institutionalSubscription domain string.
	 * @param $domain string
	 */
	function setDomain($domain) {
		return $this->setData('domain', $domain);
	}

	/**
	 * Get institutionalSubscription ip ranges.
	 * @return array 
	 */
	function getIPRanges() {
		return $this->getData('ipRanges');
	}

	/**
	 * Get institutionalSubscription ip ranges string.
	 * @return string
	 */
	function getIPRangesString() {
		$ipRanges = $this->getData('ipRanges');
		$numRanges = count($ipRanges);
		$ipRangesString = '';

		for($i=0; $i<$numRanges; $i++) {
			$ipRangesString .= $ipRanges[$i];
			if ( $i+1 < $numRanges) $ipRangesString .= '\n';
		}

		return $ipRangesString;
	}

	/**
	 * Set institutionalSubscription ip ranges.
	 * @param ipRanges array 
	 */
	function setIPRanges($ipRanges) {
		return $this->setData('ipRanges', $ipRanges);
	}

	/**
	 * Check whether subscription is valid
	 * @param $domain string
	 * @param $IP string
	 * @param $check int SUBSCRIPTION_DATE_... Test using either start date, end date, or both (default)
	 * @param $checkDate date (YYYY-MM-DD) Use this date instead of current date
	 * @return int|false Found subscription ID, or false for none.
	 */
	function isValid($domain, $IP, $check = SUBSCRIPTION_DATE_BOTH, $checkDate = null) {
		$subscriptionDao = DAORegistry::getDAO('InstitutionalSubscriptionDAO'); /* @var $subscriptionDao InstitutionalSubscriptionDAO */
		return $subscriptionDao->isValidInstitutionalSubscription($domain, $IP, $this->getData('journalId'), $check, $checkDate);
	}
}