AAAAcheckout/checkouthtml.intf.php000066600000005500151375520470012530 0ustar00 * @copyright 2012 Klarna AB (http://klarna.com) * @license http://opensource.org/licenses/BSD-2-Clause BSD-2 * @link http://integration.klarna.com/ */ /** * This interface provides methods to supply checkout page specific HTML.
* Can be used to insert device identification, fraud prevention,
* client side validation code into the checkout page. * * @category Payment * @package KlarnaAPI * @author MS Dev * @copyright 2012 Klarna AB (http://klarna.com) * @license http://opensource.org/licenses/BSD-2-Clause BSD-2 * @link http://integration.klarna.com/ */ abstract class CheckoutHTML { /** * Creates a session ID used for e.g. client identification and fraud * prevention. * * This method creates a 40 character long integer. * The first 30 numbers is microtime + random numbers. * The last 10 numbers is the eid zero-padded. * * All random functions are automatically seeded as of PHP 4.2.0. * * E.g. for eid 1004 output could be: * 1624100001298454658880354228080000001004 * * @param int $eid merchant id * * @return string A integer with a string length of 40. */ public static function getSessionID($eid) { $eid = strval($eid); while (strlen($eid) < 10) { $eid = "0" . $eid; //Zero-pad the eid. } $sid = str_replace(array(' ', ',', '.'), '', microtime()); $sid[0] = rand(1, 9); //Make sure we always have a non-zero first. //microtime + rand = 30 numbers in length while (strlen($sid) < 30) { //rand is automatically seeded as of PHP 4.2.0 $sid .= rand(0, 9999); } $sid = substr($sid, 0, 30); $sid .= $eid; return $sid; } /** * Initializes this object, this method is always called * before {@link CheckoutHTML::toHTML()}. * This method is used in {@link Klarna::addTransaction()}, * {@link Klarna::reserveAmount()} and in {@link Klarna::checkoutHTML()} * * @param Klarna $klarna The API instance * @param int $eid merchant id * * @return void */ abstract public function init($klarna, $eid); /** * This returns the HTML code for this object, * which will be used in the checkout page. * * @return string HTML */ abstract public function toHTML(); /** * This function is used to clear any stored values * (in SESSION, COOKIE or similar) * which are required to be unique between purchases. * * @return void */ abstract public function clear(); } checkout/threatmetrix.class.php000066600000007554151375520470012736 0ustar00 * @copyright 2012 Klarna AB (http://klarna.com) * @license http://opensource.org/licenses/BSD-2-Clause BSD-2 * @link http://integration.klarna.com/ */ /** * ThreatMetrix is a fraud prevention and device identification software. * * @category Payment * @package KlarnaAPI * @author MS Dev * @copyright 2012 Klarna AB (http://klarna.com) * @license http://opensource.org/licenses/BSD-2-Clause BSD-2 * @link http://integration.klarna.com/ */ class ThreatMetrix extends CheckoutHTML { /** * The ID used in conjunction with the Klarna API. * * @var int */ const ID = 'dev_id_1'; /** * ThreatMetrix organizational ID. * * @var string */ protected $orgID = 'qicrzsu4'; /** * Session ID for the client. * * @var string */ protected $sessionID; /** * Hostname used to access ThreatMetrix. * * @var string */ protected $host = 'h.online-metrix.net'; /** * Protocol used to access ThreatMetrix. * * @var string */ protected $proto = 'https'; /** * Initializes this object, this method is always called * before {@link CheckoutHTML::toHTML()}. * This method is used in {@link Klarna::addTransaction()}, * {@link Klarna::reserveAmount()} and in {@link Klarna::checkoutHTML()} * * @param Klarna $klarna The API instance * @param int $eid Merchant ID * * @return void */ public function init($klarna, $eid) { if (!is_int($eid)) { throw new Klarna_ConfigFieldMissingException('eid'); } if (isset($_SESSION)) { if (!isset($_SESSION[self::ID]) || (strlen($_SESSION[self::ID]) < 40) ) { $_SESSION[self::ID] = parent::getSessionID($eid); $this->sessionID = $_SESSION[self::ID]; } else { $this->sessionID = $_SESSION[self::ID]; } } else { $this->sessionID = parent::getSessionID($eid); } $klarna->setSessionID(self::ID, $this->sessionID); } /** * This function is used to clear any stored values * (in SESSION, COOKIE or similar) * which are required to be unique between purchases. * * @return void */ public function clear() { if (isset($_SESSION) && isset($_SESSION[self::ID])) { $_SESSION[self::ID] = null; unset($_SESSION[self::ID]); } } /** * This returns the HTML code for this object, * which will be used in the checkout page. * * @return string */ public function toHTML() { $html = "

". "". "". ""; return $html; } } checkout/index.html000066600000000057151375520470010365 0ustar00 checkout/.htaccess000066600000000177151375520470010171 0ustar00 Order allow,deny Deny from all klarnapclass.php000066600000027602151375520470007757 0ustar00 * @copyright 2012 Klarna AB (http://klarna.com) * @license http://opensource.org/licenses/BSD-2-Clause BSD-2 * @link http://integration.klarna.com/ */ /** * PClass object used for part payment. * * PClasses are used in conjunction with KlarnaCalc to determine part payment costs. * * @ignore Do not show in PHPDoc. * @category Payment * @package KlarnaAPI * @author MS Dev * @copyright 2012 Klarna AB (http://klarna.com) * @license http://opensource.org/licenses/BSD-2-Clause BSD-2 * @link http://integration.klarna.com/ */ class KlarnaPClass { /** * Invoice type/identifier, used for invoice purchases. * * @var int */ const INVOICE = -1; /** * Campaign type pclass. * * @var int */ const CAMPAIGN = 0; /** * Account type pclass. * * @var int */ const ACCOUNT = 1; /** * Special campaign type pclass.
* "Buy now, pay in x month"
* * @var int */ const SPECIAL = 2; /** * Fixed campaign type pclass * * @var int */ const FIXED = 3; /** * Delayed campaign type pclass.
* "Pay in X months"
* * @var int */ const DELAY = 4; /** * Klarna Mobile type pclass * * @var int */ const MOBILE = 5; /** * The description for this PClass. * HTML entities for special characters. * * @ignore Do not show in PHPDoc. * @var string */ protected $description; /** * Number of months for this PClass. * * @ignore Do not show in PHPDoc. * @var int */ protected $months; /** * PClass starting fee. * * @ignore Do not show in PHPDoc. * @var float */ protected $startFee; /** * PClass invoice/handling fee. * * @ignore Do not show in PHPDoc. * @var float */ protected $invoiceFee; /** * PClass interest rate. * * @ignore Do not show in PHPDoc. * @var float */ protected $interestRate; /** * PClass minimum amount for purchase/product. * * @ignore Do not show in PHPDoc. * @var float */ protected $minAmount; /** * PClass country. * * @ignore Do not show in PHPDoc. * @see KlarnaCountry * @var int */ protected $country; /** * PClass ID. * * @ignore Do not show in PHPDoc. * @var int */ protected $id; /** * PClass type. * * @see self::CAMPAIGN * @see self::ACCOUNT * @see self::SPECIAL * @see self::FIXED * @see self::DELAY * @see self::MOBILE * * @ignore Do not show in PHPDoc. * @var int */ protected $type; /** * Expire date / valid until date as unix timestamp.
* Compare it with e.g. $_SERVER['REQUEST_TIME'].
* * @ignore Do not show in PHPDoc. * @var int */ protected $expire; /** * Merchant ID / Estore ID. * * @ignore Do not show in PHPDoc. * @var int */ protected $eid; /** * Class constructor * * The optional array argument can be: * array ( * 0 = eid (this is created in the API) * 1 = id number * 2 = description * 3 = amount of months for part payment * 4 = start fee * 5 = invoice fee * 6 = interest rate * 7 = minimum purchase amount for pclass * 8 = country * 9 = type * (This is used to determine which pclass-id is an account and * a campaign, 0 = campaign, 1 = account, 2 = special campaign * i.e. x-mas campaign) * 10 = expire date * * @param null|array $arr Associative or numeric array of PClass data. */ public function __construct($arr = null) { if (!is_array($arr) || count($arr) < 11) { return; } foreach ($arr as $key => $val) { switch($key) { case "0": case "eid": $this->setEid($val); break; case "1": case "id": $this->setId($val); break; case "2": case "desc": case "description": $this->setDescription($val); break; case "3": case "months": $this->setMonths($val); break; case "4": case "startfee": $this->setStartFee($val); break; case "5": case "invoicefee": $this->setInvoiceFee($val); break; case "6": case "interestrate": $this->setInterestRate($val); break; case "7": case "minamount": $this->setMinAmount($val); break; case "8": case "country": $this->setCountry($val); break; case "9": case "type": $this->setType($val); break; case "10": case "expire": $this->setExpire($val); break; default: //Array index not supported. break; } } } /** * Returns an associative array mirroring this PClass. * * @return array */ public function toArray() { return array( 'eid' => $this->eid, 'id' => $this->id, 'description' => $this->description, 'months' => $this->months, 'startfee' => $this->startFee, 'invoicefee' => $this->invoiceFee, 'interestrate' => $this->interestRate, 'minamount' => $this->minAmount, 'country' => $this->country, 'type' => $this->type, 'expire' => $this->expire ); } /** * Sets the descriptiton, converts to HTML entities. * * @param string $description PClass description. * * @return void */ public function setDescription($description) { $this->description = $description; } /** * Sets the number of months. * * @param int $months Number of months. * * @return void */ public function setMonths($months) { $this->months = intval($months); } /** * Sets the starting fee. * * @param float $startFee Starting fee. * * @return void */ public function setStartFee($startFee) { $this->startFee = floatval($startFee); } /** * Sets the invoicing/handling fee. * * @param float $invoiceFee Invoicing fee. * * @return void */ public function setInvoiceFee($invoiceFee) { $this->invoiceFee = floatval($invoiceFee); } /** * Sets the interest rate. * * @param float $interestRate Interest rate. * * @return void */ public function setInterestRate($interestRate) { $this->interestRate = floatval($interestRate); } /** * Sets the Minimum amount to use this PClass. * * @param float $minAmount Minimum amount. * * @return void */ public function setMinAmount($minAmount) { $this->minAmount = floatval($minAmount); } /** * Sets the country for this PClass. * * @param int $country {@link KlarnaCountry} constant. * * @see KlarnaCountry * * @return void */ public function setCountry($country) { $this->country = intval($country); } /** * Sets the ID for this pclass. * * @param int $id PClass identifier. * * @return void */ public function setId($id) { $this->id = intval($id); } /** * Sets the type for this pclass. * * @param int $type PClass type identifier. * * @see self::CAMPAIGN * @see self::ACCOUNT * @see self::SPECIAL * @see self::FIXED * @see self::DELAY * @see self::MOBILE * * @return void */ public function setType($type) { $this->type = intval($type); } /** * Returns the ID for this PClass. * * @return int PClass identifier. */ public function getId() { return $this->id; } /** * Returns this PClass's type. * * @see self::CAMPAIGN * @see self::ACCOUNT * @see self::SPECIAL * @see self::FIXED * @see self::DELAY * @see self::MOBILE * * @return int PClass type identifier. */ public function getType() { return $this->type; } /** * Returns the Merchant ID or Estore ID connected to this PClass. * * @return int */ public function getEid() { return $this->eid; } /** * Merchant ID or Estore ID connected to this PClass. * * @param int $eid Merchant ID. * * @return void */ public function setEid($eid) { $this->eid = intval($eid); } /** * Checks whether this PClass is valid. * * @param int $now Unix timestamp * * @return bool */ public function isValid($now = null) { if ($this->expire == null || $this->expire == '-' || $this->expire <= 0 ) { //No expire, or unset? assume valid. return true; } if ($now === null || !is_numeric($now)) { $now = time(); } //If now is before expire, it is still valid. return ($now > $this->expire) ? false : true; } /** * Returns the valid until/expire date unix timestamp. * * @return int */ public function getExpire() { return $this->expire; } /** * Sets the valid until/expire date unix timestamp. * * @param int $expire unix timestamp for expire * * @return void */ public function setExpire($expire) { $this->expire = $expire; } /** * Returns the description for this PClass. * * Note:
* Encoded with HTML entities. * * @return string PClass description. */ public function getDescription() { return $this->description; } /** * Returns the number of months for this PClass. * * @return int Number of months. */ public function getMonths() { return $this->months; } /** * Returns the starting fee for this PClass. * * @return float Starting fee. */ public function getStartFee() { return $this->startFee; } /** * Returns the invoicing/handling fee for this PClass. * * @return float Invoicing fee. */ public function getInvoiceFee() { return $this->invoiceFee; } /** * Returns the interest rate for this PClass. * * @return float Interest rate. */ public function getInterestRate() { return $this->interestRate; } /** * Returns the minimum order/product amount for which this PClass is allowed. * * @return float Minimum amount to use this PClass. */ public function getMinAmount() { return $this->minAmount; } /** * Returns the country related to this PClass. * * @see KlarnaCountry * @return int {@link KlarnaCountry} constant. */ public function getCountry() { return $this->country; } } Currency.php000066600000004104151375520470007063 0ustar00 * @copyright 2012 Klarna AB (http://klarna.com) * @license http://opensource.org/licenses/BSD-2-Clause BSD-2 * @link http://integration.klarna.com/ */ /** * Currency Constants class * * @category Payment * @package KlarnaAPI * @author MS Dev * @copyright 2012 Klarna AB (http://klarna.com) * @license http://opensource.org/licenses/BSD-2-Clause BSD-2 * @link http://integration.klarna.com/ */ class KlarnaCurrency { /** * Currency constant for Swedish Crowns (SEK). * * @var int */ const SEK = 0; /** * Currency constant for Norwegian Crowns (NOK). * * @var int */ const NOK = 1; /** * Currency constant for Euro. * * @var int */ const EUR = 2; /** * Currency constant for Danish Crowns (DKK). * * @var int */ const DKK = 3; /** * Converts a currency code, e.g. 'eur' to the KlarnaCurrency constant. * * @param string $val currency code * * @return int|null */ public static function fromCode($val) { switch(strtolower($val)) { case 'dkk': return self::DKK; case 'eur': case 'euro': return self::EUR; case 'nok': return self::NOK; case 'sek': return self::SEK; default: return null; } } /** * Converts a KlarnaCurrency constant to the respective language code. * * @param int $val KlarnaCurrency constant * * @return string|null */ public static function getCode($val) { switch($val) { case self::DKK: return 'dkk'; case self::EUR: return 'eur'; case self::NOK: return 'nok'; case self::SEK: return 'sek'; default: return null; } } } Exceptions.php000066600000043364151375520470007425 0ustar00 * @copyright 2012 Klarna AB (http://klarna.com) * @license http://opensource.org/licenses/BSD-2-Clause BSD-2 * @link http://integration.klarna.com/ */ require_once 'Country.php'; /** * KlarnaException class, only used so it says "KlarnaException" instead of * Exception. * * @category Payment * @package KlarnaAPI * @author MS Dev * @copyright 2012 Klarna AB (http://klarna.com) * @license http://opensource.org/licenses/BSD-2-Clause BSD-2 * @link http://integration.klarna.com/ */ class KlarnaException extends Exception { /** * Returns an error message readable by end customers. * * @return string */ public function __toString() { return $this->getMessage() . " (#".$this->code.")"; } } /** * Exception for invalid Configuration object * * @category Payment * @package KlarnaAPI * @author MS Dev * @copyright 2012 Klarna AB (http://klarna.com) * @license http://opensource.org/licenses/BSD-2-Clause BSD-2 * @link http://integration.klarna.com/ */ class Klarna_InvalidConfigurationException extends KlarnaException { /** * Constructor */ public function __construct() { parent::__construct( "Supplied config is not a KlarnaConfig/ArrayAccess object!", 50001 ); } } /** * Exception for incomplete Configuration object * * @category Payment * @package KlarnaAPI * @author MS Dev * @copyright 2012 Klarna AB (http://klarna.com) * @license http://opensource.org/licenses/BSD-2-Clause BSD-2 * @link http://integration.klarna.com/ */ class Klarna_IncompleteConfigurationException extends KlarnaException { /** * Constructor */ public function __construct() { parent::__construct('Klarna instance not fully configured!', 50002); } } /** * Exception for invalid KlarnaAddr object * * @category Payment * @package KlarnaAPI * @author MS Dev * @copyright 2012 Klarna AB (http://klarna.com) * @license http://opensource.org/licenses/BSD-2-Clause BSD-2 * @link http://integration.klarna.com/ */ class Klarna_InvalidKlarnaAddrException extends KlarnaException { /** * Constructor */ public function __construct() { parent::__construct( "Supplied address is not a KlarnaAddr object!", 50011 ); } } /** * Exception for no KlarnaAddr set * * @category Payment * @package KlarnaAPI * @author MS Dev * @copyright 2012 Klarna AB (http://klarna.com) * @license http://opensource.org/licenses/BSD-2-Clause BSD-2 * @link http://integration.klarna.com/ */ class Klarna_MissingAddressException extends KlarnaException { /** * Constructor */ public function __construct() { parent::__construct("No address set!", 50035); } } /** * Exception for missing Configuration field * * @category Payment * @package KlarnaAPI * @author MS Dev * @copyright 2012 Klarna AB (http://klarna.com) * @license http://opensource.org/licenses/BSD-2-Clause BSD-2 * @link http://integration.klarna.com/ */ class Klarna_ConfigFieldMissingException extends KlarnaException { /** * Constructor * * @param string $field config field */ public function __construct($field) { parent::__construct("Config field '{$field}' is not valid!", 50003); } } /** * Exception for Unknown Encoding * * @category Payment * @package KlarnaAPI * @author MS Dev * @copyright 2012 Klarna AB (http://klarna.com) * @license http://opensource.org/licenses/BSD-2-Clause BSD-2 * @link http://integration.klarna.com/ */ class Klarna_UnknownEncodingException extends KlarnaException { /** * Constructor * * @param int $encoding encoding */ public function __construct($encoding) { parent::__construct( "Unknown PNO/SSN encoding constant! ({$encoding})", 50091 ); } } /** * Exception for Unknown Address Type * * @category Payment * @package KlarnaAPI * @author MS Dev * @copyright 2012 Klarna AB (http://klarna.com) * @license http://opensource.org/licenses/BSD-2-Clause BSD-2 * @link http://integration.klarna.com/ */ class Klarna_UnknownAddressTypeException extends KlarnaException { /** * Constructor * * @param int $type type */ public function __construct($type) { parent::__construct("Unknown address type: {$type}", 50012); } } /** * Exception for Missing Country * * @category Payment * @package KlarnaAPI * @author MS Dev * @copyright 2012 Klarna AB (http://klarna.com) * @license http://opensource.org/licenses/BSD-2-Clause BSD-2 * @link http://integration.klarna.com/ */ class Klarna_MissingCountryException extends KlarnaException { /** * Constructor */ public function __construct() { parent::__construct('You must set country first!', 50046); } } /** * Exception for Unknown Country * * @category Payment * @package KlarnaAPI * @author MS Dev * @copyright 2012 Klarna AB (http://klarna.com) * @license http://opensource.org/licenses/BSD-2-Clause BSD-2 * @link http://integration.klarna.com/ */ class Klarna_UnknownCountryException extends KlarnaException { /** * Constructor * * @param mixed $country country */ public function __construct($country) { parent::__construct("Unknown country! ({$country})", 50006); } } /** * Exception for Unknown Language * * @category Payment * @package KlarnaAPI * @author MS Dev * @copyright 2012 Klarna AB (http://klarna.com) * @license http://opensource.org/licenses/BSD-2-Clause BSD-2 * @link http://integration.klarna.com/ */ class Klarna_UnknownLanguageException extends KlarnaException { /** * Constructor * * @param mixed $language language */ public function __construct($language) { parent::__construct("Unknown language! ({$language})", 50007); } } /** * Exception for Unknown Currency * * @category Payment * @package KlarnaAPI * @author MS Dev * @copyright 2012 Klarna AB (http://klarna.com) * @license http://opensource.org/licenses/BSD-2-Clause BSD-2 * @link http://integration.klarna.com/ */ class Klarna_UnknownCurrencyException extends KlarnaException { /** * Constructor * * @param mixed $currency currency */ public function __construct($currency) { parent::__construct("Unknown currency! ({$currency})", 50008); } } /** * Exception for Missing Arguments * * @category Payment * @package KlarnaAPI * @author MS Dev * @copyright 2012 Klarna AB (http://klarna.com) * @license http://opensource.org/licenses/BSD-2-Clause BSD-2 * @link http://integration.klarna.com/ */ class Klarna_ArgumentNotSetException extends KlarnaException { /** * Constructor * * @param string $argument argument */ public function __construct($argument) { parent::__construct("Argument '{$argument}' not set!", 50005); } } /** * Exception for Country and Currency mismatch * * @category Payment * @package KlarnaAPI * @author MS Dev * @copyright 2012 Klarna AB (http://klarna.com) * @license http://opensource.org/licenses/BSD-2-Clause BSD-2 * @link http://integration.klarna.com/ */ class Klarna_CountryCurrencyMismatchException extends KlarnaException { /** * Constructor * * @param mixed $country country * @param mixed $currency currency */ public function __construct($country, $currency) { $countryCode = KlarnaCountry::getCode($country); parent::__construct( "Mismatching country/currency for '{$countryCode}'! ". "[country: $country currency: $currency]", 50011 ); } } /** * Exception for Country and Currency mismatch * * @category Payment * @package KlarnaAPI * @author MS Dev * @copyright 2012 Klarna AB (http://klarna.com) * @license http://opensource.org/licenses/BSD-2-Clause BSD-2 * @link http://integration.klarna.com/ */ class Klarna_CountryLanguageMismatchException extends KlarnaException { /** * Constructor * * @param mixed $country country * @param mixed $language language */ public function __construct($country, $language) { $countryCode = KlarnaCountry::getCode($country); parent::__construct( "Mismatching country/language for '{$countryCode}'! ". "[country: $country language: $language]", 50024 ); } } /** * Exception for Shipping country being different from set country * * @category Payment * @package KlarnaAPI * @author MS Dev * @copyright 2012 Klarna AB (http://klarna.com) * @license http://opensource.org/licenses/BSD-2-Clause BSD-2 * @link http://integration.klarna.com/ */ class Klarna_ShippingCountryException extends KlarnaException { /** * Constructor */ public function __construct() { parent::__construct( 'Shipping address country must match the country set!', 50041 ); } } /** * Exception for Missing Goodslist * * @category Payment * @package KlarnaAPI * @author MS Dev * @copyright 2012 Klarna AB (http://klarna.com) * @license http://opensource.org/licenses/BSD-2-Clause BSD-2 * @link http://integration.klarna.com/ */ class Klarna_MissingGoodslistException extends KlarnaException { /** * Constructor */ public function __construct() { parent::__construct("No articles in goodslist!", 50034); } } /** * Exception for invalid price * * @category Payment * @package KlarnaAPI * @author MS Dev * @copyright 2012 Klarna AB (http://klarna.com) * @license http://opensource.org/licenses/BSD-2-Clause BSD-2 * @link http://integration.klarna.com/ */ class Klarna_InvalidPriceException extends KlarnaException { /** * Constructor * * @param mixed $price price */ public function __construct($price) { parent::__construct( "price/amount must be an integer and greater than 0! ($price)", 50039 ); } } /** * Exception for invalid pcstorage class * * @category Payment * @package KlarnaAPI * @author MS Dev * @copyright 2012 Klarna AB (http://klarna.com) * @license http://opensource.org/licenses/BSD-2-Clause BSD-2 * @link http://integration.klarna.com/ */ class Klarna_PCStorageInvalidException extends KlarnaException { /** * Constructor * * @param string $className classname * @param string $pclassStorage pcstorage class file */ public function __construct($className, $pclassStorage) { parent::__construct( "$className located in $pclassStorage is not a PCStorage instance.", 50052 ); } } /** * Exception for invalid type * * @category Payment * @package KlarnaAPI * @author MS Dev * @copyright 2012 Klarna AB (http://klarna.com) * @license http://opensource.org/licenses/BSD-2-Clause BSD-2 * @link http://integration.klarna.com/ */ class Klarna_InvalidTypeException extends KlarnaException { /** * Constructor * * @param string $param parameter * @param string $type type */ public function __construct($param, $type) { parent::__construct( "$param is not of the expected type. Expected: $type.", 50062 ); } } /** * Exception for invalid PNO * * @category Payment * @package KlarnaAPI * @author MS Dev * @copyright 2012 Klarna AB (http://klarna.com) * @license http://opensource.org/licenses/BSD-2-Clause BSD-2 * @link http://integration.klarna.com/ */ class Klarna_InvalidPNOException extends KlarnaException { /** * Constructor */ public function __construct() { parent::__construct("PNO/SSN is not valid!", 50078); } } /** * Exception for invalid Email * * @category Payment * @package KlarnaAPI * @author MS Dev * @copyright 2012 Klarna AB (http://klarna.com) * @license http://opensource.org/licenses/BSD-2-Clause BSD-2 * @link http://integration.klarna.com/ */ class Klarna_InvalidEmailException extends KlarnaException { /** * Constructor */ public function __construct() { parent::__construct("Email is not valid!", 50017); } } /** * Exception for invalid Email * * @category Payment * @package KlarnaAPI * @author MS Dev * @copyright 2012 Klarna AB (http://klarna.com) * @license http://opensource.org/licenses/BSD-2-Clause BSD-2 * @link http://integration.klarna.com/ */ class Klarna_UnsupportedMarketException extends KlarnaException { /** * Constructor * * @param string|array $countries allowed countries */ public function __construct($countries) { if (is_array($countries)) { $countries = implode(", ", $countries); } parent::__construct( "This method is only available for customers from: {$countries}", 50025 ); } } /** * Exception for invalid Locale * * @category Payment * @package KlarnaAPI * @author MS Dev * @copyright 2012 Klarna AB (http://klarna.com) * @license http://opensource.org/licenses/BSD-2-Clause BSD-2 * @link http://integration.klarna.com/ */ class Klarna_InvalidLocaleException extends KlarnaException { /** * Constructor */ public function __construct() { parent::__construct( "You must set country, language and currency!", 50023 ); } } /** * Exception for Missing Address Fields * * @category Payment * @package KlarnaAPI * @author MS Dev * @copyright 2012 Klarna AB (http://klarna.com) * @license http://opensource.org/licenses/BSD-2-Clause BSD-2 * @link http://integration.klarna.com/ */ class Klarna_AddressFieldMissingException extends KlarnaException { /** * Constructor * * @param string $argument argument */ public function __construct($argument) { parent::__construct("'{$argument}' not set!", 50015); } } /** * Exception for File Not Writable * * @category Payment * @package KlarnaAPI * @author MS Dev * @copyright 2012 Klarna AB (http://klarna.com) * @license http://opensource.org/licenses/BSD-2-Clause BSD-2 * @link http://integration.klarna.com/ */ class Klarna_FileNotWritableException extends KlarnaException { /** * Constructor * * @param string $file filename */ public function __construct($file) { parent::__construct("Unable to write to {$file}!"); } } /** * Exception for File Not Readable * * @category Payment * @package KlarnaAPI * @author MS Dev * @copyright 2012 Klarna AB (http://klarna.com) * @license http://opensource.org/licenses/BSD-2-Clause BSD-2 * @link http://integration.klarna.com/ */ class Klarna_FileNotReadableException extends KlarnaException { /** * Constructor * * @param string $file filename */ public function __construct($file) { parent::__construct("Unable to read from {$file}!"); } } /** * Exception for File Not Readable * * @category Payment * @package KlarnaAPI * @author MS Dev * @copyright 2012 Klarna AB (http://klarna.com) * @license http://opensource.org/licenses/BSD-2-Clause BSD-2 * @link http://integration.klarna.com/ */ class Klarna_FileNotFoundException extends KlarnaException { /** * Constructor * * @param string $file filename */ public function __construct($file) { parent::__construct("Unable to find file: {$file}!"); } } /** * Exception for Database Errors * * @category Payment * @package KlarnaAPI * @author MS Dev * @copyright 2012 Klarna AB (http://klarna.com) * @license http://opensource.org/licenses/BSD-2-Clause BSD-2 * @link http://integration.klarna.com/ */ class Klarna_DatabaseException extends KlarnaException { } /** * Exception for PClass Errors * * @category Payment * @package KlarnaAPI * @author MS Dev * @copyright 2012 Klarna AB (http://klarna.com) * @license http://opensource.org/licenses/BSD-2-Clause BSD-2 * @link http://integration.klarna.com/ */ class Klarna_PClassException extends KlarnaException { } /** * Exception for XML Parse errors * * @category Payment * @package KlarnaAPI * @author MS Dev * @copyright 2012 Klarna AB (http://klarna.com) * @license http://opensource.org/licenses/BSD-2-Clause BSD-2 * @link http://integration.klarna.com/ */ class Klarna_XMLParseException extends KlarnaException { /** * Constructor * * @param string $file filename */ public function __construct($file) { parent::__construct("Unable to parse XML file: {$file}!"); } } Language.php000066600000021015151375520470007014 0ustar00 * @copyright 2012 Klarna AB (http://klarna.com) * @license http://opensource.org/licenses/BSD-2-Clause BSD-2 * @link http://integration.klarna.com/ */ /** * Language Constants class * * @category Payment * @package KlarnaAPI * @author MS Dev * @copyright 2012 Klarna AB (http://klarna.com) * @license http://opensource.org/licenses/BSD-2-Clause BSD-2 * @link http://integration.klarna.com/ */ class KlarnaLanguage { /** * Language constant for Danish (DA).
* ISO639_DA * * @var int */ const DA = 27; /** * Language constant for German (DE).
* ISO639_DE * * @var int */ const DE = 28; /** * Language constant for English (EN).
* ISO639_EN * * @var int */ const EN = 31; /** * Language constant for Finnish (FI).
* ISO639_FI * * @var int */ const FI = 37; /** * Language constant for Norwegian (NB).
* ISO639_NB * * @var int */ const NB = 97; /** * Language constant for Dutch (NL).
* ISO639_NL * * @var int */ const NL = 101; /** * Language constant for Swedish (SV).
* ISO639_SV * * @var int */ const SV = 138; /** * Converts a language code, e.g. 'de' to the KlarnaLanguage constant. * * @param string $val language code * * @return int|null */ public static function fromCode($val) { $val = strtoupper($val); if (array_key_exists($val, self::$_languages)) { return self::$_languages[$val]; } return null; } /** * Converts a KlarnaLanguage constant to the respective language code. * * @param int $val KlarnaLanguage constant * * @return lowercase string|null */ public static function getCode($val) { if (self::$_languageFlip === array()) { self::$_languageFlip = array_flip(self::$_languages); } if (array_key_exists($val, self::$_languageFlip)) { return strtolower(self::$_languageFlip[$val]); } return null; } /** * Cache for the flipped language array * * @var array */ private static $_languageFlip = array(); /** * Array containing all languages and their KRED Code * * @var array */ private static $_languages = array( 'AA' => 1, // Afar 'AB' => 2, // Abkhazian 'AE' => 3, // Avestan 'AF' => 4, // Afrikaans 'AM' => 5, // Amharic 'AR' => 6, // Arabic 'AS' => 7, // Assamese 'AY' => 8, // Aymara 'AZ' => 9, // Azerbaijani 'BA' => 10, // Bashkir 'BE' => 11, // Byelorussian; Belarusian 'BG' => 12, // Bulgarian 'BH' => 13, // Bihari 'BI' => 14, // Bislama 'BN' => 15, // Bengali; Bangla 'BO' => 16, // Tibetan 'BR' => 17, // Breton 'BS' => 18, // Bosnian 'CA' => 19, // Catalan 'CE' => 20, // Chechen 'CH' => 21, // Chamorro 'CO' => 22, // Corsican 'CS' => 23, // Czech 'CU' => 24, // Church Slavic 'CV' => 25, // Chuvash 'CY' => 26, // Welsh 'DA' => 27, // Danish 'DE' => 28, // German 'DZ' => 29, // Dzongkha; Bhutani 'EL' => 30, // Greek 'EN' => 31, // English 'EO' => 32, // Esperanto 'ES' => 33, // Spanish 'ET' => 34, // Estonian 'EU' => 35, // Basque 'FA' => 36, // Persian 'FI' => 37, // Finnish 'FJ' => 38, // Fijian; Fiji 'FO' => 39, // Faroese 'FR' => 40, // French 'FY' => 41, // Frisian 'GA' => 42, // Irish 'GD' => 43, // Scots; Gaelic 'GL' => 44, // Gallegan; Galician 'GN' => 45, // Guarani 'GU' => 46, // Gujarati 'GV' => 47, // Manx 'HA' => 48, // Hausa 'HE' => 49, // Hebrew (formerly iw) 'HI' => 50, // Hindi 'HO' => 51, // Hiri Motu 'HR' => 52, // Croatian 'HU' => 53, // Hungarian 'HY' => 54, // Armenian 'HZ' => 55, // Herero 'IA' => 56, // Interlingua 'ID' => 57, // Indonesian (formerly in) 'IE' => 58, // Interlingue 'IK' => 59, // Inupiak 'IO' => 60, // Ido 'IS' => 61, // Icelandic 'IT' => 62, // Italian 'IU' => 63, // Inuktitut 'JA' => 64, // Japanese 'JV' => 65, // Javanese 'KA' => 66, // Georgian 'KI' => 67, // Kikuyu 'KJ' => 68, // Kuanyama 'KK' => 69, // Kazakh 'KL' => 70, // Kalaallisut; Greenlandic 'KM' => 71, // Khmer; Cambodian 'KN' => 72, // Kannada 'KO' => 73, // Korean 'KS' => 74, // Kashmiri 'KU' => 75, // Kurdish 'KV' => 76, // Komi 'KW' => 77, // Cornish 'KY' => 78, // Kirghiz 'LA' => 79, // Latin 'LB' => 80, // Letzeburgesch 'LN' => 81, // Lingala 'LO' => 82, // Lao; Laotian 'LT' => 83, // Lithuanian 'LV' => 84, // Latvian; Lettish 'MG' => 85, // Malagasy 'MH' => 86, // Marshall 'MI' => 87, // Maori 'MK' => 88, // Macedonian 'ML' => 89, // Malayalam 'MN' => 90, // Mongolian 'MO' => 91, // Moldavian 'MR' => 92, // Marathi 'MS' => 93, // Malay 'MT' => 94, // Maltese 'MY' => 95, // Burmese 'NA' => 96, // Nauru 'NB' => 97, // Norwegian Bokmål 'ND' => 98, // Ndebele, North 'NE' => 99, // Nepali 'NG' => 100, // Ndonga 'NL' => 101, // Dutch 'NN' => 102, // Norwegian Nynorsk 'NO' => 103, // Norwegian 'NR' => 104, // Ndebele, South 'NV' => 105, // Navajo 'NY' => 106, // Chichewa; Nyanja 'OC' => 107, // Occitan; Provençal 'OM' => 108, // (Afan) Oromo 'OR' => 109, // Oriya 'OS' => 110, // Ossetian; Ossetic 'PA' => 111, // Panjabi; Punjabi 'PI' => 112, // Pali 'PL' => 113, // Polish 'PS' => 114, // Pashto, Pushto 'PT' => 115, // Portuguese 'QU' => 116, // Quechua 'RM' => 117, // Rhaeto-Romance 'RN' => 118, // Rundi; Kirundi 'RO' => 119, // Romanian 'RU' => 120, // Russian 'RW' => 121, // Kinyarwanda 'SA' => 122, // Sanskrit 'SC' => 123, // Sardinian 'SD' => 124, // Sindhi 'SE' => 125, // Northern Sami 'SG' => 126, // Sango; Sangro 'SI' => 127, // Sinhalese 'SK' => 128, // Slovak 'SL' => 129, // Slovenian 'SM' => 130, // Samoan 'SN' => 131, // Shona 'SO' => 132, // Somali 'SQ' => 133, // Albanian 'SR' => 134, // Serbian 'SS' => 135, // Swati; Siswati 'ST' => 136, // Sesotho; Sotho, Southern 'SU' => 137, // Sundanese 'SV' => 138, // Swedish 'SW' => 139, // Swahili 'TA' => 140, // Tamil 'TE' => 141, // Telugu 'TG' => 142, // Tajik 'TH' => 143, // Thai 'TI' => 144, // Tigrinya 'TK' => 145, // Turkmen 'TL' => 146, // Tagalog 'TN' => 147, // Tswana; Setswana 'TO' => 148, // Tongan 'TR' => 149, // Turkish 'TS' => 150, // Tsonga 'TT' => 151, // Tatar 'TW' => 152, // Twi 'TY' => 153, // Tahitian 'UG' => 154, // Uighur 'UK' => 155, // Ukrainian 'UR' => 156, // Urdu 'UZ' => 157, // Uzbek 'VI' => 158, // Vietnamese 'VO' => 159, // Volapuk 'WA' => 160, // Walloon 'WO' => 161, // Wolof 'XH' => 162, // Xhosa 'YI' => 163, // Yiddish (formerly ji) 'YO' => 164, // Yoruba 'ZA' => 165, // Zhuang 'ZH' => 166, // Chinese 'ZU' => 167 // Zulu ); } .htaccess000066600000000177151375520470006364 0ustar00 Order allow,deny Deny from all klarna.php000066600000405552151375520470006555 0ustar00 * @copyright 2012 Klarna AB (http://klarna.com) * @license http://opensource.org/licenses/BSD-2-Clause BSD-2 * @link http://integration.klarna.com/ */ /** * This API provides a way to integrate with Klarna's services over the * XMLRPC protocol. * * All strings inputted need to be encoded with ISO-8859-1.
* In addition you need to decode HTML entities, if they exist.
* * For more information see our * {@link http://integration.klarna.com/en/api/step-by-step step by step} guide. * * Dependencies: * * xmlrpc-3.0.0.beta/lib/xmlrpc.inc * from {@link http://phpxmlrpc.sourceforge.net/} * * xmlrpc-3.0.0.beta/lib/xmlrpc_wrappers.inc * from {@link http://phpxmlrpc.sourceforge.net/} * * @category Payment * @package KlarnaAPI * @author MS Dev * @copyright 2012 Klarna AB (http://klarna.com) * @license http://opensource.org/licenses/BSD-2-Clause BSD-2 * @link http://integration.klarna.com/ */ class Klarna { /** * Klarna PHP API version identifier. * * @var string */ protected $VERSION = 'php:api:2.4.2'; /** * Klarna protocol identifier. * * @var string */ protected $PROTO = '4.1'; /** * Flag to indicate use of the report server Candice. * * @var bool */ private static $_candice = true; /** * URL/Address to the Candice server. * Port used is 80. * * @var string */ private static $_c_addr = "clientstat.klarna.com"; /** * Constants used with LIVE mode for the communications with Klarna. * * @var int */ const LIVE = 0; /** * URL/Address to the live Klarna Online server. * Port used is 443 for SSL and 80 without. * * @var string */ private static $_live_addr = 'payment.klarna.com'; /** * Constants used with BETA mode for the communications with Klarna. * * @var int */ const BETA = 1; /** * URL/Address to the beta test Klarna Online server. * Port used is 443 for SSL and 80 without. * * @var string */ private static $_beta_addr = 'payment.testdrive.klarna.com'; /** * Indicates whether the communications is over SSL or not. * * @var bool */ protected $ssl = false; /** * An object of xmlrpc_client, used to communicate with Klarna. * * @link http://phpxmlrpc.sourceforge.net/ * * @var xmlrpc_client */ protected $xmlrpc; /** * Which server the Klarna API is using, LIVE or BETA (TESTING). * * @see Klarna::LIVE * @see Klarna::BETA * * @var int */ protected $mode; /** * Associative array holding url information. * * @var array */ private $_url; /** * The estore's identifier received from Klarna. * * @var int */ private $_eid; /** * The estore's shared secret received from Klarna. * * Note:
* DO NOT SHARE THIS WITH ANYONE! * * @var string */ private $_secret; /** * KlarnaCountry constant. * * @see KlarnaCountry * * @var int */ private $_country; /** * KlarnaCurrency constant. * * @see KlarnaCurrency * * @var int */ private $_currency; /** * KlarnaLanguage constant. * * @see KlarnaLanguage * * @var int */ private $_language; /** * An array of articles for the current order. * * @var array */ protected $goodsList; /** * An array of article numbers and quantity. * * @var array */ protected $artNos; /** * An KlarnaAddr object containing the billing address. * * @var KlarnaAddr */ protected $billing; /** * An KlarnaAddr object containing the shipping address. * * @var KlarnaAddr */ protected $shipping; /** * Estore's user(name) or identifier. * Only used in {@link Klarna::addTransaction()}. * * @var string */ protected $estoreUser = ""; /** * External order numbers from other systems. * * @var string */ protected $orderid = array("", ""); /** * Reference (person) parameter. * * @var string */ protected $reference = ""; /** * Reference code parameter. * * @var string */ protected $reference_code = ""; /** * An array of named extra info. * * @var array */ protected $extraInfo = array(); /** * An array of named bank info. * * @var array */ protected $bankInfo = array(); /** * An array of named income expense info. * * @var array */ protected $incomeInfo = array(); /** * An array of named shipment info. * * @var array */ protected $shipInfo = array(); /** * An array of named travel info. * * @ignore Do not show this in PHPDoc. * @var array */ protected $travelInfo = array(); /** * An array of named activate info * * @ignore * @var array */ protected $activateInfo = array(); /** * An array of named session id's.
* E.g. "dev_id_1" => ...
* * @var array */ protected $sid = array(); /** * A comment sent in the XMLRPC communications. * This is resetted using clear(). * * @var string */ protected $comment = ""; /** * An array with all the checkoutHTML objects. * * @var array */ protected $coObjects = array(); /** * Flag to indicate if the API should output verbose * debugging information. * * @var bool */ public static $debug = false; /** * Turns on the internal XMLRPC debugging. * * @var bool */ public static $xmlrpcDebug = false; /** * If this is set to true, XMLRPC invocation is disabled. * * @var bool */ public static $disableXMLRPC = false; /** * If the estore is using a proxy which populates the clients IP to * x_forwarded_for * then and only then should this be set to true. * * Note:
* USE WITH CARE! * * @var bool */ public static $x_forwarded_for = false; /** * Array of HTML entities, used to create numeric htmlentities. * * @ignore Do not show this in PHPDoc. * @var array */ protected static $htmlentities = false; /** * Populated with possible proxy information. * A comma separated list of IP addresses. * * @var string */ private $_x_fwd; /** * The storage class for PClasses. * * Use 'xml' for xmlstorage.class.php.
* Use 'mysql' for mysqlstorage.class.php.
* Use 'json' for jsonstorage.class.php.
* * @var string */ protected $pcStorage; /** * The storage URI for PClasses. * * Use the absolute or relative URI to a file if * {@link Klarna::$pcStorage} is set as 'xml' or 'json'.
* Use a HTTP-auth similar URL if {@link Klarna::$pcStorage} is set * as 'mysql',
* e.g. user:passwd@addr:port/dbName.dbTable.
* Or an associative array (recommended) {@see MySQLStorage} * * @var mixed */ protected $pcURI; /** * PCStorage instance. * * @ignore Do not show this in PHPDoc. * @var PCStorage */ protected $pclasses; /** * ArrayAccess instance. * * @ignore Do not show this in PHPDoc. * @var ArrayAccess */ protected $config; /** * Empty constructor, because sometimes it's needed. */ public function __construct() { } /** * Checks if the config has fields described in argument.
* Missing field(s) is in the exception message. * * To check that the config has eid and secret:
* * try { * $this->hasFields('eid', 'secret'); * } * catch(Exception $e) { * echo "Missing fields: " . $e->getMessage(); * } * * * @throws Exception * @return void */ protected function hasFields(/*variable arguments*/) { $missingFields = array(); $args = func_get_args(); foreach ($args as $field) { if (!isset($this->config[$field])) { $missingFields[] = $field; } } if (count($missingFields) > 0) { throw new Klarna_ConfigFieldMissingException( implode(', ', $missingFields) ); } } /** * Initializes the Klarna object accordingly to the set config object. * * @throws KlarnaException * @return void */ protected function init() { $this->hasFields('eid', 'secret', 'mode', 'pcStorage', 'pcURI'); if (!is_int($this->config['eid'])) { $this->config['eid'] = intval($this->config['eid']); } if ($this->config['eid'] <= 0) { throw new Klarna_ConfigFieldMissingException('eid'); } if (!is_string($this->config['secret'])) { $this->config['secret'] = strval($this->config['secret']); } if (strlen($this->config['secret']) == 0) { throw new Klarna_ConfigFieldMissingException('secret'); } //Set the shop id and secret. $this->_eid = $this->config['eid']; $this->_secret = $this->config['secret']; //Set the country specific attributes. try { $this->hasFields('country', 'language', 'currency'); //If hasFields doesn't throw exception we can set them all. $this->setCountry($this->config['country']); $this->setLanguage($this->config['language']); $this->setCurrency($this->config['currency']); } catch(Exception $e) { //fields missing for country, language or currency $this->_country = $this->_language = $this->_currency = null; } //Set addr and port according to mode. $this->mode = (int)$this->config['mode']; $this->_url = array(); // If a custom url has been added to the config, use that as xmlrpc // recipient. if (isset($this->config['url'])) { $this->_url = parse_url($this->config['url']); if ($this->_url === false) { $message = "Configuration value 'url' could not be parsed. " . "(Was: '{$this->config['url']}')"; Klarna::printDebug(__METHOD__, $message); throw new InvalidArgumentException($message); } } else { $this->_url['scheme'] = 'https'; if ($this->mode === self::LIVE) { $this->_url['host'] = self::$_live_addr; } else { $this->_url['host'] = self::$_beta_addr; } if (isset($this->config['ssl']) && (bool)$this->config['ssl'] === false ) { $this->_url['scheme'] = 'http'; } } // If no port has been specified, deduce from url scheme if (!array_key_exists('port', $this->_url)) { if ($this->_url['scheme'] === 'https') { $this->_url['port'] = 443; } else { $this->_url['port'] = 80; } } try { $this->hasFields('candice'); self::$_candice = (bool)$this->config['candice']; } catch(Exception $e) { //No 'candice' field ignore it... } try { $this->hasFields('xmlrpcDebug'); Klarna::$xmlrpcDebug = $this->config['xmlrpcDebug']; } catch(Exception $e) { //No 'xmlrpcDebug' field ignore it... } try { $this->hasFields('debug'); Klarna::$debug = $this->config['debug']; } catch(Exception $e) { //No 'debug' field ignore it... } $this->pcStorage = $this->config['pcStorage']; $this->pcURI = $this->config['pcURI']; // Default path to '/' if not set. if (!array_key_exists('path', $this->_url)) { $this->_url['path'] = '/'; } $this->xmlrpc = new xmlrpc_client( $this->_url['path'], $this->_url['host'], $this->_url['port'], $this->_url['scheme'] ); $this->xmlrpc->request_charset_encoding = 'ISO-8859-1'; } /** * Method of ease for setting common config fields. * * The storage module for PClasses:
* Use 'xml' for xmlstorage.class.php.
* Use 'mysql' for mysqlstorage.class.php.
* Use 'json' for jsonstorage.class.php.
* * The storage URI for PClasses:
* Use the absolute or relative URI to a file if {@link Klarna::$pcStorage} * is set as 'xml' or 'json'.
* Use a HTTP-auth similar URL if {@link Klarna::$pcStorage} is set as * mysql', e.g. user:passwd@addr:port/dbName.dbTable. * Or an associative array (recommended) {@see MySQLStorage} * * Note:
* This disables the config file storage.
* * @param int $eid Merchant ID/EID * @param string $secret Secret key/Shared key * @param int $country {@link KlarnaCountry} * @param int $language {@link KlarnaLanguage} * @param int $currency {@link KlarnaCurrency} * @param int $mode {@link Klarna::LIVE} or {@link Klarna::BETA} * @param string $pcStorage PClass storage module. * @param string $pcURI PClass URI. * @param bool $ssl Whether HTTPS (HTTP over SSL) or HTTP is used. * @param bool $candice Error reporting to Klarna. * * @see Klarna::setConfig() * @see KlarnaConfig * * @throws KlarnaException * @return void */ public function config( $eid, $secret, $country, $language, $currency, $mode = Klarna::LIVE, $pcStorage = 'json', $pcURI = 'pclasses.json', $ssl = true, $candice = true ) { try { KlarnaConfig::$store = false; $this->config = new KlarnaConfig(null); $this->config['eid'] = $eid; $this->config['secret'] = $secret; $this->config['country'] = $country; $this->config['language'] = $language; $this->config['currency'] = $currency; $this->config['mode'] = $mode; $this->config['ssl'] = $ssl; $this->config['candice'] = $candice; $this->config['pcStorage'] = $pcStorage; $this->config['pcURI'] = $pcURI; $this->init(); } catch(Exception $e) { $this->config = null; throw new KlarnaException( $e->getMessage(), $e->getCode() ); } } /** * Sets and initializes this Klarna object using the supplied config object. * * @param KlarnaConfig &$config Config object. * * @see KlarnaConfig * @throws KlarnaException * @return void */ public function setConfig(&$config) { $this->_checkConfig($config); $this->config = $config; $this->init(); } /** * Get the complete locale (country, language, currency) to use for the * values passed, or the configured value if passing null. * * @param mixed $country country constant or code * @param mixed $language language constant or code * @param mixed $currency currency constant or code * * @throws KlarnaException * @return array */ public function getLocale( $country = null, $language = null, $currency = null ) { $locale = array( 'country' => null, 'language' => null, 'currency' => null ); if ($country === null) { // Use the configured country / language / currency $locale['country'] = $this->_country; if ($this->_language !== null) { $locale['language'] = $this->_language; } if ($this->_currency !== null) { $locale['currency'] = $this->_currency; } } else { // Use the given country / language / currency if (!is_numeric($country)) { $country = KlarnaCountry::fromCode($country); } $locale['country'] = intval($country); if ($language !== null) { if (!is_numeric($language)) { $language = KlarnaLanguage::fromCode($language); } $locale['language'] = intval($language); } if ($currency !== null) { if (!is_numeric($currency)) { $currency = KlarnaCurrency::fromCode($currency); } $locale['currency'] = intval($currency); } } // Complete partial structure with defaults if ($locale['currency'] === null) { $locale['currency'] = $this->getCurrencyForCountry( $locale['country'] ); } if ($locale['language'] === null) { $locale['language'] = $this->getLanguageForCountry( $locale['country'] ); } $this->_checkCountry($locale['country']); $this->_checkCurrency($locale['currency']); $this->_checkLanguage($locale['language']); return $locale; } /** * Sets the country used. * * Note:
* If you input 'dk', 'fi', 'de', 'nl', 'no' or 'se',
* then currency and language will be set to mirror that country.
* * @param string|int $country {@link KlarnaCountry} * * @see KlarnaCountry * * @throws KlarnaException * @return void */ public function setCountry($country) { if (!is_numeric($country) && (strlen($country) == 2 || strlen($country) == 3) ) { $country = KlarnaCountry::fromCode($country); } $this->_checkCountry($country); $this->_country = $country; } /** * Returns the country code for the set country constant. * * @param int $country {@link KlarnaCountry Country} constant. * * @return string Two letter code, e.g. "se", "no", etc. */ public function getCountryCode($country = null) { if ($country === null) { $country = $this->_country; } $code = KlarnaCountry::getCode($country); return (string) $code; } /** * Returns the {@link KlarnaCountry country} constant from the country code. * * @param string $code Two letter code, e.g. "se", "no", etc. * * @throws KlarnaException * @return int {@link KlarnaCountry Country} constant. */ public static function getCountryForCode($code) { $country = KlarnaCountry::fromCode($code); if ($country === null) { throw new Klarna_UnknownCountryException($code); } return $country; } /** * Returns the country constant. * * @return int {@link KlarnaCountry} */ public function getCountry() { return $this->_country; } /** * Sets the language used. * * Note:
* You can use the two letter language code instead of the constant.
* E.g. 'da' instead of using {@link KlarnaLanguage::DA}.
* * @param string|int $language {@link KlarnaLanguage} * * @see KlarnaLanguage * * @throws KlarnaException * @return void */ public function setLanguage($language) { if (!is_numeric($language) && strlen($language) == 2) { $this->setLanguage(self::getLanguageForCode($language)); } else { $this->_checkLanguage($language); $this->_language = $language; } } /** * Returns the language code for the set language constant. * * @param int $language {@link KlarnaLanguage Language} constant. * * @return string Two letter code, e.g. "da", "de", etc. */ public function getLanguageCode($language = null) { if ($language === null) { $language = $this->_language; } $code = KlarnaLanguage::getCode($language); return (string) $code; } /** * Returns the {@link KlarnaLanguage language} constant from the language code. * * @param string $code Two letter code, e.g. "da", "de", etc. * * @throws KlarnaException * @return int {@link KlarnaLanguage Language} constant. */ public static function getLanguageForCode($code) { $language = KlarnaLanguage::fromCode($code); if ($language === null) { throw new Klarna_UnknownLanguageException($code); } return $language; } /** * Returns the language constant. * * @return int {@link KlarnaLanguage} */ public function getLanguage() { return $this->_language; } /** * Sets the currency used. * * Note:
* You can use the three letter shortening of the currency.
* E.g. "dkk", "eur", "nok" or "sek" instead of the constant.
* * @param string|int $currency {@link KlarnaCurrency} * * @see KlarnaCurrency * * @throws KlarnaException * @return void */ public function setCurrency($currency) { if (!is_numeric($currency) && strlen($currency) == 3) { $this->setCurrency(self::getCurrencyForCode($currency)); } else { $this->_checkCurrency($currency); $this->_currency = $currency; } } /** * Returns the {@link KlarnaCurrency currency} constant from the currency * code. * * @param string $code Two letter code, e.g. "dkk", "eur", etc. * * @throws KlarnaException * @return int {@link KlarnaCurrency Currency} constant. */ public static function getCurrencyForCode($code) { $currency = KlarnaCurrency::fromCode($code); if ($currency === null) { throw new Klarna_UnknownCurrencyException($code); } return $currency; } /** * Returns the the currency code for the set currency constant. * * @param int $currency {@link KlarnaCurrency Currency} constant. * * @return string Three letter currency code. */ public function getCurrencyCode($currency = null) { if ($currency === null) { $currency = $this->_currency; } $code = KlarnaCurrency::getCode($currency); return (string) $code; } /** * Returns the set currency constant. * * @return int {@link KlarnaCurrency} */ public function getCurrency() { return $this->_currency; } /** * Returns the {@link KlarnaLanguage language} constant for the specified * or set country. * * @param int $country {@link KlarnaCountry Country} constant. * * @deprecated Do not use. * * @return int|false if no match otherwise KlarnaLanguage constant. */ public function getLanguageForCountry($country = null) { if ($country === null) { $country = $this->_country; } // Since getLanguage defaults to EN, check so we actually have a match $language = KlarnaCountry::getLanguage($country); if (KlarnaCountry::checkLanguage($country, $language)) { return $language; } return false; } /** * Returns the {@link KlarnaCurrency currency} constant for the specified * or set country. * * @param int $country {@link KlarnaCountry country} constant. * * @deprecated Do not use. * * @return int|false {@link KlarnaCurrency currency} constant. */ public function getCurrencyForCountry($country = null) { if ($country === null) { $country = $this->_country; } return KlarnaCountry::getCurrency($country); } /** * Sets the session id's for various device identification, * behaviour identification software. * * Available named session id's:
* string - dev_id_1
* string - dev_id_2
* string - dev_id_3
* string - beh_id_1
* string - beh_id_2
* string - beh_id_3
* * @param string $name Session ID identifier, e.g. 'dev_id_1'. * @param string $sid Session ID. * * @throws KlarnaException * @return void */ public function setSessionID($name, $sid) { $this->_checkArgument($name, "name"); $this->_checkArgument($sid, "sid"); $this->sid[$name] = $sid; } /** * Sets the shipment information for the upcoming transaction.
* * Using this method is optional. * * Available named values are:
* int - delay_adjust
* string - shipping_company
* string - shipping_product
* string - tracking_no
* array - warehouse_addr
* * "warehouse_addr" is sent using {@link KlarnaAddr::toArray()}. * * Make sure you send in the values as the right data type.
* Use strval, intval or similar methods to ensure the right type is sent. * * @param string $name key * @param mixed $value value * * @throws KlarnaException * @return void */ public function setShipmentInfo($name, $value) { $this->_checkArgument($name, "name"); $this->shipInfo[$name] = $value; } /** * Sets the Activation information for the upcoming transaction.
* * Using this method is optional. * * Available named values are:
* int - flags
* int - bclass
* string - orderid1
* string - orderid2
* string - ocr
* string - reference
* string - reference_code
* string - cust_no
* * Make sure you send in the values as the right data type.
* Use strval, intval or similar methods to ensure the right type is sent. * * @param string $name key * @param mixed $value value * * @see setShipmentInfo * * @return void */ public function setActivateInfo($name, $value) { $this->activateInfo[$name] = $value; } /** * Sets the extra information for the upcoming transaction.
* * Using this method is optional. * * Available named values are:
* string - cust_no
* string - estore_user
* string - maiden_name
* string - place_of_birth
* string - password
* string - new_password
* string - captcha
* int - poa_group
* string - poa_pno
* string - ready_date
* string - rand_string
* int - bclass
* string - pin
* * Make sure you send in the values as the right data type.
* Use strval, intval or similar methods to ensure the right type is sent. * * @param string $name key * @param mixed $value value * * @throws KlarnaException * @return void */ public function setExtraInfo($name, $value) { $this->_checkArgument($name, "name"); $this->extraInfo[$name] = $value; } /** * Sets the income expense information for the upcoming transaction.
* * Using this method is optional. * * Available named values are:
* int - yearly_salary
* int - no_people_in_household
* int - no_children_below_18
* int - net_monthly_household_income
* int - monthly_cost_accommodation
* int - monthly_cost_other_loans
* * Make sure you send in the values as the right data type.
* Use strval, intval or similar methods to ensure the right type is sent. * * @param string $name key * @param mixed $value value * * @throws KlarnaException * @return void */ public function setIncomeInfo($name, $value) { $this->_checkArgument($name, "name"); $this->incomeInfo[$name] = $value; } /** * Sets the bank information for the upcoming transaction.
* * Using this method is optional. * * Available named values are:
* int - bank_acc_bic
* int - bank_acc_no
* int - bank_acc_pin
* int - bank_acc_tan
* string - bank_name
* string - bank_city
* string - iban
* * Make sure you send in the values as the right data type.
* Use strval, intval or similar methods to ensure the right type is sent. * * @param string $name key * @param mixed $value value * * @throws KlarnaException * @return void */ public function setBankInfo($name, $value) { $this->_checkArgument($name, "name"); $this->bankInfo[$name] = $value; } /** * Sets the travel information for the upcoming transaction.
* * Using this method is optional. * * Available named values are:
* string - travel_company
* string - reseller_company
* string - departure_date
* string - return_date
* array - destinations
* array - passenger_list
* array - passport_no
* array - driver_license_no
* * Make sure you send in the values as the right data type.
* Use strval, intval or similar methods to ensure the right type is sent. * * @param string $name key * @param mixed $value value * * @throws KlarnaException * @return void */ public function setTravelInfo($name, $value) { $this->_checkArgument($name, "name"); $this->travelInfo[$name] = $value; } /** * Returns the clients IP address. * * @return string */ public function getClientIP() { $tmp_ip = ''; $x_fwd = null; //Proxy handling. if (array_key_exists('REMOTE_ADDR', $_SERVER)) { $tmp_ip = $_SERVER['REMOTE_ADDR']; } if (isset($_SERVER["HTTP_X_FORWARDED_FOR"])) { $x_fwd = $_SERVER["HTTP_X_FORWARDED_FOR"]; } if (self::$x_forwarded_for && ($x_fwd !== null)) { $forwarded = explode(",", $x_fwd); return trim($forwarded[0]); } return $tmp_ip; } /** * Sets the specified address for the current order. * * Address type can be:
* {@link KlarnaFlags::IS_SHIPPING}
* {@link KlarnaFlags::IS_BILLING}
* * @param int $type Address type. * @param KlarnaAddr $addr Specified address. * * @throws KlarnaException * @return void */ public function setAddress($type, $addr) { if (!($addr instanceof KlarnaAddr)) { throw new Klarna_InvalidKlarnaAddrException; } if ($addr->isCompany === null) { $addr->isCompany = false; } if ($type === KlarnaFlags::IS_SHIPPING) { $this->shipping = $addr; self::printDebug("shipping address array", $this->shipping); return; } if ($type === KlarnaFlags::IS_BILLING) { $this->billing = $addr; self::printDebug("billing address array", $this->billing); return; } throw new Klarna_UnknownAddressTypeException($type); } /** * Sets order id's from other systems for the upcoming transaction.
* User is only sent with {@link Klarna::addTransaction()}.
* * @param string $orderid1 order id 1 * @param string $orderid2 order id 2 * @param string $user username * * @see Klarna::setExtraInfo() * * @throws KlarnaException * @return void */ public function setEstoreInfo($orderid1 = "", $orderid2 = "", $user = "") { if (!is_string($orderid1)) { $orderid1 = strval($orderid1); } if (!is_string($orderid2)) { $orderid2 = strval($orderid2); } if (!is_string($user)) { $user = strval($user); } if (strlen($user) > 0 ) { $this->setExtraInfo('estore_user', $user); } $this->orderid[0] = $orderid1; $this->orderid[1] = $orderid2; } /** * Sets the reference (person) and reference code, for the upcoming * transaction. * * If this is omitted, it can grab first name, last name from the address * and use that as a reference person. * * @param string $ref Reference person / message to customer on invoice. * @param string $code Reference code / message to customer on invoice. * * @return void */ public function setReference($ref, $code) { $this->_checkRef($ref, $code); $this->reference = $ref; $this->reference_code = $code; } /** * Returns the reference (person). * * @return string */ public function getReference() { return $this->reference; } /** * Returns an associative array used to send the address to Klarna. * TODO: Kill it all * * @param KlarnaAddr $addr Address object to assemble. * * @throws KlarnaException * @return array The address for the specified method. */ protected function assembleAddr($addr) { if (!($addr instanceof KlarnaAddr)) { throw new Klarna_InvalidKlarnaAddrException; } return $addr->toArray(); } /** * Sets the comment field, which can be shown in the invoice. * * @param string $data comment to set * * @return void */ public function setComment($data) { $this->comment = $data; } /** * Adds an additional comment to the comment field. Appends with a newline. * * @param string $data comment to add * * @see Klarna::setComment() * * @return void */ public function addComment($data) { $this->comment .= "\n".$data; } /** * Returns the PNO/SSN encoding constant for currently set country. * * Note:
* Country, language and currency needs to match! * * @throws KlarnaException * @return int {@link KlarnaEncoding} constant. */ public function getPNOEncoding() { $this->_checkLocale(); $country = KlarnaCountry::getCode($this->_country); return KlarnaEncoding::get($country); } /** * Purpose: The get_addresses function is used to retrieve a customer's * address(es). Using this, the customer is not required to enter any * information, only confirm the one presented to him/her.
* * The get_addresses function can also be used for companies.
* If the customer enters a company number, it will return all the * addresses where the company is registered at.
* * The get_addresses function is ONLY allowed to be used for Swedish * persons with the following conditions: *
    *
  • * It can be only used if invoice or part payment is * the default payment method *
  • *
  • * It has to disappear if the customer chooses another * payment method *
  • *
  • * The button is not allowed to be called "get address", but * "continue" or
    * it can be picked up automatically when all the numbers have * been typed. *
  • *
* * Type can be one of these:
* {@link KlarnaFlags::GA_ALL},
* {@link KlarnaFlags::GA_LAST},
* {@link KlarnaFlags::GA_GIVEN}.
* * @param string $pno Social security number, personal number, ... * @param int $encoding {@link KlarnaEncoding PNO Encoding} constant. * @param int $type Specifies returned information. * * @link http://integration.klarna.com/en/api/standard-integration/functions * /getaddresses * @throws KlarnaException * @return array An array of {@link KlarnaAddr} objects. */ public function getAddresses( $pno, $encoding = null, $type = KlarnaFlags::GA_GIVEN ) { if ($this->_country !== KlarnaCountry::SE) { throw new Klarna_UnsupportedMarketException("Sweden"); } //Get the PNO/SSN encoding constant. if ($encoding === null) { $encoding = $this->getPNOEncoding(); } $this->_checkPNO($pno, $encoding); $digestSecret = self::digest( $this->colon( $this->_eid, $pno, $this->_secret ) ); $paramList = array( $pno, $this->_eid, $digestSecret, $encoding, $type, $this->getClientIP() ); self::printDebug("get_addresses array", $paramList); $result = $this->xmlrpc_call('get_addresses', $paramList); self::printDebug("get_addresses result array", $result); $addrs = array(); foreach ($result as $tmpAddr) { try { $addr = new KlarnaAddr(); if ($type === KlarnaFlags::GA_GIVEN) { $addr->isCompany = (count($tmpAddr) == 5) ? true : false; if ($addr->isCompany) { $addr->setCompanyName($tmpAddr[0]); $addr->setStreet($tmpAddr[1]); $addr->setZipCode($tmpAddr[2]); $addr->setCity($tmpAddr[3]); $addr->setCountry($tmpAddr[4]); } else { $addr->setFirstName($tmpAddr[0]); $addr->setLastName($tmpAddr[1]); $addr->setStreet($tmpAddr[2]); $addr->setZipCode($tmpAddr[3]); $addr->setCity($tmpAddr[4]); $addr->setCountry($tmpAddr[5]); } } else if ($type === KlarnaFlags::GA_LAST) { // Here we cannot decide if it is a company or not? // Assume private person. $addr->setLastName($tmpAddr[0]); $addr->setStreet($tmpAddr[1]); $addr->setZipCode($tmpAddr[2]); $addr->setCity($tmpAddr[3]); $addr->setCountry($tmpAddr[4]); } else if ($type === KlarnaFlags::GA_ALL) { if (strlen($tmpAddr[0]) > 0) { $addr->setFirstName($tmpAddr[0]); $addr->setLastName($tmpAddr[1]); } else { $addr->isCompany = true; $addr->setCompanyName($tmpAddr[1]); } $addr->setStreet($tmpAddr[2]); $addr->setZipCode($tmpAddr[3]); $addr->setCity($tmpAddr[4]); $addr->setCountry($tmpAddr[5]); } else { continue; } $addrs[] = $addr; } catch(Exception $e) { //Silently fail } } return $addrs; } /** * Adds an article to the current goods list for the current order. * * Note:
* It is recommended that you use {@link KlarnaFlags::INC_VAT}.
* * Flags can be:
* {@link KlarnaFlags::INC_VAT}
* {@link KlarnaFlags::IS_SHIPMENT}
* {@link KlarnaFlags::IS_HANDLING}
* {@link KlarnaFlags::PRINT_1000}
* {@link KlarnaFlags::PRINT_100}
* {@link KlarnaFlags::PRINT_10}
* {@link KlarnaFlags::NO_FLAG}
* * Some flags can be added to each other for multiple options. * * @param int $qty Quantity. * @param string $artNo Article number. * @param string $title Article title. * @param int $price Article price. * @param float $vat VAT in percent, e.g. 25% is inputted as 25. * @param float $discount Possible discount on article. * @param int $flags Options which specify the article * ({@link KlarnaFlags::IS_HANDLING}) and it's price * ({@link KlarnaFlags::INC_VAT}) * * @see Klarna::addTransaction() * @see Klarna::reserveAmount() * @see Klarna::activateReservation() * * @throws KlarnaException * @return void */ public function addArticle( $qty, $artNo, $title, $price, $vat, $discount = 0, $flags = KlarnaFlags::INC_VAT ) { $this->_checkQty($qty); // Either artno or title has to be set if ((($artNo === null ) || ($artNo == "")) && (($title === null ) || ($title == "")) ) { throw new Klarna_ArgumentNotSetException('Title and ArtNo', 50026); } $this->_checkPrice($price); $this->_checkVAT($vat); $this->_checkDiscount($discount); $this->_checkInt($flags, 'flags'); //Create goodsList array if not set. if (!$this->goodsList || !is_array($this->goodsList)) { $this->goodsList = array(); } //Populate a temp array with the article details. $tmpArr = array( "artno" => $artNo, "title" => $title, "price" => $price, "vat" => $vat, "discount" => $discount, "flags" => $flags ); //Add the temp array and quantity field to the internal goods list. $this->goodsList[] = array( "goods" => $tmpArr, "qty" => $qty ); if (count($this->goodsList) > 0) { self::printDebug( "article added", $this->goodsList[count($this->goodsList)-1] ); } } /** * Assembles and sends the current order to Klarna.
* This clears all relevant data if $clear is set to true.
* * This method returns an array with:
* Invoice number
* Order status flag
* * If the flag {@link KlarnaFlags::RETURN_OCR} is used:
* Invoice number
* OCR number
* Order status flag
* * Order status can be:
* {@link KlarnaFlags::ACCEPTED}
* {@link KlarnaFlags::PENDING}
* {@link KlarnaFlags::DENIED}
* * Gender is only required for Germany and Netherlands.
* * Flags can be:
* {@link KlarnaFlags::NO_FLAG}
* {@link KlarnaFlags::TEST_MODE}
* {@link KlarnaFlags::AUTO_ACTIVATE}
* {@link KlarnaFlags::SENSITIVE_ORDER}
* {@link KlarnaFlags::RETURN_OCR}
* {@link KlarnaFlags::M_PHONE_TRANSACTION}
* {@link KlarnaFlags::M_SEND_PHONE_PIN}
* * Some flags can be added to each other for multiple options. * * Note:
* Normal shipment type is assumed unless otherwise specified, * ou can do this by calling:
* {@link Klarna::setShipmentInfo() setShipmentInfo('delay_adjust', ...)} * with either:
* {@link KlarnaFlags::NORMAL_SHIPMENT NORMAL_SHIPMENT} or * {@link KlarnaFlags::EXPRESS_SHIPMENT EXPRESS_SHIPMENT}
* * @param string $pno Personal number, SSN, date of birth, etc. * @param int $gender {@link KlarnaFlags::FEMALE} or * {@link KlarnaFlags::MALE}, * null or "" for unspecified. * @param int $flags Options which affect the behaviour. * @param int $pclass PClass id used for this invoice. * @param int $encoding {@link KlarnaEncoding Encoding} constant for the * PNO parameter. * @param bool $clear Whether customer info should be cleared after * this call or not. * * @link http://integration.klarna.com/en/api/standard-integration/functions/ * addtransaction * * @throws KlarnaException * @return array An array with invoice number and order status. [string, int] */ public function addTransaction( $pno, $gender, $flags = KlarnaFlags::NO_FLAG, $pclass = KlarnaPClass::INVOICE, $encoding = null, $clear = true ) { $this->_checkLocale(50023); //Get the PNO/SSN encoding constant. if ($encoding === null) { $encoding = $this->getPNOEncoding(); } if (!($flags & KlarnaFlags::PRE_PAY)) { $this->_checkPNO($pno, $encoding); } if ($gender === 'm') { $gender = KlarnaFlags::MALE; } else if ($gender === 'f') { $gender = KlarnaFlags::FEMALE; } if ($gender !== null && strlen($gender) > 0) { $this->_checkInt($gender, 'gender'); } $this->_checkInt($flags, 'flags'); $this->_checkInt($pclass, 'pclass'); //Check so required information is set. $this->_checkGoodslist(); //We need at least one address set if (!($this->billing instanceof KlarnaAddr) && !($this->shipping instanceof KlarnaAddr) ) { throw new Klarna_MissingAddressException; } //If only one address is set, copy to the other address. if (!($this->shipping instanceof KlarnaAddr) && ($this->billing instanceof KlarnaAddr) ) { $this->shipping = $this->billing; } else if (!($this->billing instanceof KlarnaAddr) && ($this->shipping instanceof KlarnaAddr) ) { $this->billing = $this->shipping; } //Assume normal shipment unless otherwise specified. if (!isset($this->shipInfo['delay_adjust'])) { $this->setShipmentInfo('delay_adjust', KlarnaFlags::NORMAL_SHIPMENT); } //Make sure we get any session ID's or similar $this->initCheckout(); //function add_transaction_digest $string = ""; foreach ($this->goodsList as $goods) { $string .= $goods['goods']['title'] .':'; } $digestSecret = self::digest($string . $this->_secret); //end function add_transaction_digest $billing = $this->assembleAddr($this->billing); $shipping = $this->assembleAddr($this->shipping); //Shipping country must match specified country! if (strlen($shipping['country']) > 0 && ($shipping['country'] !== $this->_country) ) { throw new Klarna_ShippingCountryException; } $paramList = array( $pno, $gender, $this->reference, $this->reference_code, $this->orderid[0], $this->orderid[1], $shipping, $billing, $this->getClientIP(), $flags, $this->_currency, $this->_country, $this->_language, $this->_eid, $digestSecret, $encoding, $pclass, $this->goodsList, $this->comment, $this->shipInfo, $this->travelInfo, $this->incomeInfo, $this->bankInfo, $this->sid, $this->extraInfo ); self::printDebug('add_invoice', $paramList); $result = $this->xmlrpc_call('add_invoice', $paramList); if ($clear === true) { //Make sure any stored values that need to be unique between //purchases are cleared. foreach ($this->coObjects as $co) { $co->clear(); } $this->clear(); } self::printDebug('add_invoice result', $result); return $result; } /** * Activates previously created invoice * (from {@link Klarna::addTransaction()}). * * Note:
* If you want to change the shipment type, you can specify it using: * {@link Klarna::setShipmentInfo() setShipmentInfo('delay_adjust', ...)} * with either: {@link KlarnaFlags::NORMAL_SHIPMENT NORMAL_SHIPMENT} or * {@link KlarnaFlags::EXPRESS_SHIPMENT EXPRESS_SHIPMENT} * * @param string $invNo Invoice number. * @param int $pclass PClass id used for this invoice. * @param bool $clear Whether customer info should be cleared after this * call. * * @see Klarna::setShipmentInfo() * @link http://integration.klarna.com/en/api/standard-integration/functions * /activateinvoice * * @throws KlarnaException * @return string An URL to the PDF invoice. */ public function activateInvoice( $invNo, $pclass = KlarnaPClass::INVOICE, $clear = true ) { $this->_checkInvNo($invNo); $digestSecret = self::digest( $this->colon($this->_eid, $invNo, $this->_secret) ); $paramList = array( $this->_eid, $invNo, $digestSecret, $pclass, $this->shipInfo ); self::printDebug('activate_invoice', $paramList); $result = $this->xmlrpc_call('activate_invoice', $paramList); if ($clear === true) { $this->clear(); } self::printDebug('activate_invoice result', $result); return $result; } /** * Removes a passive invoices which has previously been created with * {@link Klarna::addTransaction()}. * True is returned if the invoice was successfully removed, otherwise an * exception is thrown.
* * @param string $invNo Invoice number. * * @throws KlarnaException * @return bool */ public function deleteInvoice($invNo) { $this->_checkInvNo($invNo); $digestSecret = self::digest( $this->colon($this->_eid, $invNo, $this->_secret) ); $paramList = array( $this->_eid, $invNo, $digestSecret ); self::printDebug('delete_invoice', $paramList); $result = $this->xmlrpc_call('delete_invoice', $paramList); return ($result == 'ok') ? true : false; } /** * Summarizes the prices of the held goods list * * @return int total amount */ public function summarizeGoodsList() { $amount = 0; if (!is_array($this->goodsList)) { return $amount; } foreach ($this->goodsList as $goods) { $price = $goods['goods']['price']; // Add VAT if price is Excluding VAT if (($goods['goods']['flags'] & KlarnaFlags::INC_VAT) === 0) { $vat = $goods['goods']['vat'] / 100.0; $price *= (1.0 + $vat); } // Reduce discounts if ($goods['goods']['discount'] > 0) { $discount = $goods['goods']['discount'] / 100.0; $price *= (1.0 - $discount); } $amount += $price * (int)$goods['qty']; } return $amount; } /** * Reserves a purchase amount for a specific customer.
* The reservation is valid, by default, for 7 days.
* * This method returns an array with:
* A reservation number (rno)
* Order status flag
* * Order status can be:
* {@link KlarnaFlags::ACCEPTED}
* {@link KlarnaFlags::PENDING}
* {@link KlarnaFlags::DENIED}
* * Please note:
* Activation must be done with activate_reservation, i.e. you cannot * activate through Klarna Online. * * Gender is only required for Germany and Netherlands.
* * Flags can be set to:
* {@link KlarnaFlags::NO_FLAG}
* {@link KlarnaFlags::TEST_MODE}
* {@link KlarnaFlags::RSRV_SENSITIVE_ORDER}
* {@link KlarnaFlags::RSRV_PHONE_TRANSACTION}
* {@link KlarnaFlags::RSRV_SEND_PHONE_PIN}
* * Some flags can be added to each other for multiple options. * * Note:
* Normal shipment type is assumed unless otherwise specified, you can do * this by calling:
* {@link Klarna::setShipmentInfo() setShipmentInfo('delay_adjust', ...)} * with either: {@link KlarnaFlags::NORMAL_SHIPMENT NORMAL_SHIPMENT} or * {@link KlarnaFlags::EXPRESS_SHIPMENT EXPRESS_SHIPMENT}
* * @param string $pno Personal number, SSN, date of birth, etc. * @param int $gender {@link KlarnaFlags::FEMALE} or * {@link KlarnaFlags::MALE}, null for unspecified. * @param int $amount Amount to be reserved, including VAT. * @param int $flags Options which affect the behaviour. * @param int $pclass {@link KlarnaPClass::getId() PClass ID}. * @param int $encoding {@link KlarnaEncoding PNO Encoding} constant. * @param bool $clear Whether customer info should be cleared after * this call. * * @link http://integration.klarna.com/en/api/advanced-integration * /functions/reserveamount * * @throws KlarnaException * @return array An array with reservation number and order * status. [string, int] */ public function reserveAmount( $pno, $gender, $amount, $flags = 0, $pclass = KlarnaPClass::INVOICE, $encoding = null, $clear = true ) { $this->_checkLocale(); //Get the PNO/SSN encoding constant. if ($encoding === null) { $encoding = $this->getPNOEncoding(); } $this->_checkPNO($pno, $encoding); if ($gender === 'm') { $gender = KlarnaFlags::MALE; } else if ($gender === 'f') { $gender = KlarnaFlags::FEMALE; } if ($gender !== null && strlen($gender) > 0) { $this->_checkInt($gender, 'gender'); } $this->_checkInt($flags, 'flags'); $this->_checkInt($pclass, 'pclass'); //Check so required information is set. $this->_checkGoodslist(); //Calculate automatically the amount from goodsList. if ($amount === -1) { $amount = (int)round($this->summarizeGoodsList()); } else { $this->_checkAmount($amount); } if ($amount < 0) { throw new Klarna_InvalidPriceException($amount); } //No addresses used for phone transactions if ($flags & KlarnaFlags::RSRV_PHONE_TRANSACTION) { $billing = $shipping = ''; } else { $billing = $this->assembleAddr($this->billing); $shipping = $this->assembleAddr($this->shipping); if (strlen($shipping['country']) > 0 && ($shipping['country'] !== $this->_country) ) { throw new Klarna_ShippingCountryException; } } //Assume normal shipment unless otherwise specified. if (!isset($this->shipInfo['delay_adjust'])) { $this->setShipmentInfo('delay_adjust', KlarnaFlags::NORMAL_SHIPMENT); } //Make sure we get any session ID's or similar $this->initCheckout($this, $this->_eid); $digestSecret = self::digest( "{$this->_eid}:{$pno}:{$amount}:{$this->_secret}" ); $paramList = array( $pno, $gender, $amount, $this->reference, $this->reference_code, $this->orderid[0], $this->orderid[1], $shipping, $billing, $this->getClientIP(), $flags, $this->_currency, $this->_country, $this->_language, $this->_eid, $digestSecret, $encoding, $pclass, $this->goodsList, $this->comment, $this->shipInfo, $this->travelInfo, $this->incomeInfo, $this->bankInfo, $this->sid, $this->extraInfo ); self::printDebug('reserve_amount', $paramList); $result = $this->xmlrpc_call('reserve_amount', $paramList); if ($clear === true) { //Make sure any stored values that need to be unique between //purchases are cleared. foreach ($this->coObjects as $co) { $co->clear(); } $this->clear(); } self::printDebug('reserve_amount result', $result); return $result; } /** * Cancels a reservation. * * @param string $rno Reservation number. * * @link http://integration.klarna.com/en/api/advanced-integration/functions * /cancelreservation * * @throws KlarnaException * @return bool True, if the cancellation was successful. */ public function cancelReservation($rno) { $this->_checkRNO($rno); $digestSecret = self::digest( $this->colon($this->_eid, $rno, $this->_secret) ); $paramList = array( $rno, $this->_eid, $digestSecret ); self::printDebug('cancel_reservation', $paramList); $result = $this->xmlrpc_call('cancel_reservation', $paramList); return ($result == 'ok'); } /** * Changes specified reservation to a new amount. * * Flags can be either of these:
* {@link KlarnaFlags::NEW_AMOUNT}
* {@link KlarnaFlags::ADD_AMOUNT}
* * @param string $rno Reservation number. * @param int $amount Amount including VAT. * @param int $flags Options which affect the behaviour. * * @link http://integration.klarna.com/en/api/advanced-integration/functions * /changereservation * * @throws KlarnaException * @return bool True, if the change was successful. */ public function changeReservation( $rno, $amount, $flags = KlarnaFlags::NEW_AMOUNT ) { $this->_checkRNO($rno); $this->_checkAmount($amount); $this->_checkInt($flags, 'flags'); $digestSecret = self::digest( $this->colon($this->_eid, $rno, $amount, $this->_secret) ); $paramList = array( $rno, $amount, $this->_eid, $digestSecret, $flags ); self::printDebug('change_reservation', $paramList); $result = $this->xmlrpc_call('change_reservation', $paramList); return ($result == 'ok') ? true : false; } /** * Update the reservation matching the given reservation number. * * @param string $rno Reservation number * @param boolean $clear clear set data aftre updating. Defaulted to true. * * @throws KlarnaException if no RNO is given, or if an error is recieved * from Klarna Online. * * @return true if the update was successful */ public function update($rno, $clear = true) { $rno = strval($rno); // All info that is sent in is part of the digest secret, in this order: // [ // proto_vsn, client_vsn, eid, rno, careof, street, zip, city, // country, fname, lname, careof, street, zip, city, country, // fname, lname, artno, qty, orderid1, orderid2 // ]. // The address part appears twice, that is one per address that // changes. If no value is sent in for an optional field, there // is no entry for this field in the digest secret. Shared secret // is added at the end of the digest secret. $digestArray = array( str_replace('.', ':', $this->PROTO), $this->VERSION, $this->_eid, $rno ); $digestArray = array_merge( $digestArray, $this->_addressDigestPart($this->shipping) ); $digestArray = array_merge( $digestArray, $this->_addressDigestPart($this->billing) ); if (is_array($this->goodsList) && $this->goodsList !== array()) { foreach ($this->goodsList as $goods) { if (strlen($goods["goods"]["artno"]) > 0) { $digestArray[] = $goods["goods"]["artno"]; } else { $digestArray[] = $goods["goods"]["title"]; } $digestArray[] = $goods["qty"]; } } foreach ($this->orderid as $orderid) { $digestArray[] = $orderid; } $digestArray[] = $this->_secret; $digestSecret = $this->digest( call_user_func_array( array('self', 'colon'), $digestArray ) ); $shipping = array(); $billing = array(); if ($this->shipping !== null && $this->shipping instanceof KlarnaAddr) { $shipping = $this->shipping->toArray(); } if ($this->billing !== null && $this->billing instanceof KlarnaAddr) { $billing = $this->billing->toArray(); } $paramList = array( $this->_eid, $digestSecret, $rno, array( 'goods_list' => $this->goodsList, 'dlv_addr' => $shipping, 'bill_addr' => $billing, 'orderid1' => $this->orderid[0], 'orderid2' => $this->orderid[1] ) ); self::printDebug('update array', $paramList); $result = $this->xmlrpc_call('update', $paramList); self::printDebug('update result', $result); return ($result === 'ok'); } /** * Help function to sort the address for update digest. * * @param KlarnaAddr|null $address KlarnaAddr object or null * * @return array */ private function _addressDigestPart(KlarnaAddr $address = null) { if ($address === null) { return array(); } $keyOrder = array( 'careof', 'street', 'zip', 'city', 'country', 'fname', 'lname' ); $holder = $address->toArray(); $digest = array(); foreach ($keyOrder as $key) { if ($holder[$key] != "") { $digest[] = $holder[$key]; } } return $digest; } /** * Activate the reservation matching the given reservation number. * Optional information should be set in ActivateInfo. * * To perform a partial activation, use the addArtNo function to specify * which items in the reservation to include in the activation. * * @param string $rno Reservation number * @param string $ocr optional OCR number to attach to the reservation when * activating. Overrides OCR specified in activateInfo. * @param string $flags optional flags to affect behavior. If specified it * will overwrite any flag set in activateInfo. * @param boolean $clear clear set data after activating. Defaulted to true. * * @throws KlarnaException when the RNO is not specified, or if an error * is recieved from Klarna Online. * @return A string array with risk status and reservation number. */ public function activate( $rno, $ocr = null, $flags = null, $clear = true ) { $this->_checkRNO($rno); // Overwrite any OCR set on activateInfo if supplied here since this // method call is more specific. if ($ocr !== null) { $this->setActivateInfo('ocr', $ocr); } // If flags is specified set the flag supplied here to activateInfo. if ($flags !== null) { $this->setActivateInfo('flags', $flags); } //Assume normal shipment unless otherwise specified. if (!array_key_exists('delay_adjust', $this->shipInfo)) { $this->setShipmentInfo('delay_adjust', KlarnaFlags::NORMAL_SHIPMENT); } // Append shipment info to activateInfo $this->activateInfo['shipment_info'] = $this->shipInfo; // Unlike other calls, if NO_FLAG is specified it should not be sent in // at all. if (array_key_exists('flags', $this->activateInfo) && $this->activateInfo['flags'] === KlarnaFlags::NO_FLAG ) { unset($this->activateInfo['flags']); } // Build digest. Any field in activateInfo that is set is included in // the digest. $digestArray = array( str_replace('.', ':', $this->PROTO), $this->VERSION, $this->_eid, $rno ); $optionalDigestKeys = array( 'bclass', 'cust_no', 'flags', 'ocr', 'orderid1', 'orderid2', 'reference', 'reference_code' ); foreach ($optionalDigestKeys as $key) { if (array_key_exists($key, $this->activateInfo)) { $digestArray[] = $this->activateInfo[$key]; } } if (array_key_exists('delay_adjust', $this->activateInfo['shipment_info'])) { $digestArray[] = $this->activateInfo['shipment_info']['delay_adjust']; } // If there are any artnos added with addArtNo, add them to the digest // and to the activateInfo if (is_array($this->artNos)) { foreach ($this->artNos as $artNo) { $digestArray[] = $artNo['artno']; $digestArray[] = $artNo['qty']; } $this->setActivateInfo('artnos', $this->artNos); } $digestArray[] = $this->_secret; $digestSecret = self::digest( call_user_func_array( array('self', 'colon'), $digestArray ) ); // Create the parameter list. $paramList = array( $this->_eid, $digestSecret, $rno, $this->activateInfo ); self::printDebug('activate array', $paramList); $result = $this->xmlrpc_call('activate', $paramList); self::printDebug('activate result', $result); // Clear the state if specified. if ($clear) { $this->clear(); } return $result; } /** * Activates a previously created reservation. * * This method returns an array with:
* Risk status ("no_risk", "ok")
* Invoice number
* * Gender is only required for Germany and Netherlands.
* * Use of the OCR parameter is optional. * An OCR number can be retrieved by using: * {@link Klarna::reserveOCR()} or {@link Klarna::reserveOCRemail()}. * * Flags can be set to:
* {@link KlarnaFlags::NO_FLAG}
* {@link KlarnaFlags::TEST_MODE}
* {@link KlarnaFlags::RSRV_SEND_BY_MAIL}
* {@link KlarnaFlags::RSRV_SEND_BY_EMAIL}
* {@link KlarnaFlags::RSRV_PRESERVE_RESERVATION}
* {@link KlarnaFlags::RSRV_SENSITIVE_ORDER}
* * Some flags can be added to each other for multiple options. * * Note:
* Normal shipment type is assumed unless otherwise specified, you can * do this by calling: * {@link Klarna::setShipmentInfo() setShipmentInfo('delay_adjust', ...)} * with either: {@link KlarnaFlags::NORMAL_SHIPMENT NORMAL_SHIPMENT} or * {@link KlarnaFlags::EXPRESS_SHIPMENT EXPRESS_SHIPMENT}
* * @param string $pno Personal number, SSN, date of birth, etc. * @param string $rno Reservation number. * @param int $gender {@link KlarnaFlags::FEMALE} or * {@link KlarnaFlags::MALE}, null for unspecified. * @param string $ocr A OCR number. * @param int $flags Options which affect the behaviour. * @param int $pclass {@link KlarnaPClass::getId() PClass ID}. * @param int $encoding {@link KlarnaEncoding PNO Encoding} constant. * @param bool $clear Whether customer info should be cleared after * this call. * * @link http://integration.klarna.com/en/api/advanced-integration/functions * /activatereservation * @see Klarna::reserveAmount() * * @throws KlarnaException * @return array An array with risk status and invoice number [string, string]. */ public function activateReservation( $pno, $rno, $gender, $ocr = "", $flags = KlarnaFlags::NO_FLAG, $pclass = KlarnaPClass::INVOICE, $encoding = null, $clear = true ) { $this->_checkLocale(); //Get the PNO/SSN encoding constant. if ($encoding === null) { $encoding = $this->getPNOEncoding(); } // Only check PNO if it is not explicitly null. if ($pno !== null) { $this->_checkPNO($pno, $encoding); } $this->_checkRNO($rno); if ($gender !== null && strlen($gender) > 0) { $this->_checkInt($gender, 'gender'); } $this->_checkOCR($ocr); $this->_checkRef($this->reference, $this->reference_code); $this->_checkGoodslist(); //No addresses used for phone transactions $billing = $shipping = ''; if ( !($flags & KlarnaFlags::RSRV_PHONE_TRANSACTION) ) { $billing = $this->assembleAddr($this->billing); $shipping = $this->assembleAddr($this->shipping); if (strlen($shipping['country']) > 0 && ($shipping['country'] !== $this->_country) ) { throw new Klarna_ShippingCountryException; } } //activate digest $string = $this->_eid . ":" . $pno . ":"; foreach ($this->goodsList as $goods) { $string .= $goods["goods"]["artno"] . ":" . $goods["qty"] . ":"; } $digestSecret = self::digest($string . $this->_secret); //end digest //Assume normal shipment unless otherwise specified. if (!isset($this->shipInfo['delay_adjust'])) { $this->setShipmentInfo('delay_adjust', KlarnaFlags::NORMAL_SHIPMENT); } $paramList = array( $rno, $ocr, $pno, $gender, $this->reference, $this->reference_code, $this->orderid[0], $this->orderid[1], $shipping, $billing, "0.0.0.0", $flags, $this->_currency, $this->_country, $this->_language, $this->_eid, $digestSecret, $encoding, $pclass, $this->goodsList, $this->comment, $this->shipInfo, $this->travelInfo, $this->incomeInfo, $this->bankInfo, $this->extraInfo ); self::printDebug('activate_reservation', $paramList); $result = $this->xmlrpc_call('activate_reservation', $paramList); if ($clear === true) { $this->clear(); } self::printDebug('activate_reservation result', $result); return $result; } /** * Splits a reservation due to for example outstanding articles. * * For flags usage see:
* {@link Klarna::reserveAmount()}
* * @param string $rno Reservation number. * @param int $amount The amount to be subtracted from the reservation. * @param int $flags Options which affect the behaviour. * * @link http://integration.klarna.com/en/api/advanced-integration/functions * /splitreservation * * @throws KlarnaException * @return string A new reservation number. */ public function splitReservation( $rno, $amount, $flags = KlarnaFlags::NO_FLAG ) { //Check so required information is set. $this->_checkRNO($rno); $this->_checkAmount($amount); if ($amount <= 0) { throw new Klarna_InvalidPriceException($amount); } $digestSecret = self::digest( $this->colon($this->_eid, $rno, $amount, $this->_secret) ); $paramList = array( $rno, $amount, $this->orderid[0], $this->orderid[1], $flags, $this->_eid, $digestSecret ); self::printDebug('split_reservation array', $paramList); $result = $this->xmlrpc_call('split_reservation', $paramList); self::printDebug('split_reservation result', $result); return $result; } /** * Reserves a specified number of OCR numbers.
* For the specified country or the {@link Klarna::setCountry() set country}.
* * @param int $no The number of OCR numbers to reserve. * @param int $country {@link KlarnaCountry} constant. * * @link http://integration.klarna.com/en/api/advanced-integration/functions * /reserveocrnums * * @throws KlarnaException * @return array An array of OCR numbers. */ public function reserveOCR($no, $country = null) { $this->_checkNo($no); if ($country === null) { if (!$this->_country) { throw new Klarna_MissingCountryException; } $country = $this->_country; } else { $this->_checkCountry($country); } $digestSecret = self::digest( $this->colon($this->_eid, $no, $this->_secret) ); $paramList = array( $no, $this->_eid, $digestSecret, $country ); self::printDebug('reserve_ocr_nums array', $paramList); return $this->xmlrpc_call('reserve_ocr_nums', $paramList); } /** * Reserves the number of OCRs specified and sends them to the given email. * * @param int $no Number of OCR numbers to reserve. * @param string $email address. * @param int $country {@link KlarnaCountry} constant. * * @return bool True, if the OCRs were reserved and sent. */ public function reserveOCRemail($no, $email, $country = null) { $this->_checkNo($no); $this->_checkPNO($email, KlarnaEncoding::EMAIL); if ($country === null) { if (!$this->_country) { throw new Klarna_MissingCountryException; } $country = $this->_country; } else { $this->_checkCountry($country); } $digestSecret = self::digest( $this->colon($this->_eid, $no, $this->_secret) ); $paramList = array( $no, $email, $this->_eid, $digestSecret, $country ); self::printDebug('reserve_ocr_nums_email array', $paramList); $result = $this->xmlrpc_call('reserve_ocr_nums_email', $paramList); return ($result == 'ok'); } /** * Checks if the specified SSN/PNO has an part payment account with Klarna. * * @param string $pno Social security number, Personal number, ... * @param int $encoding {@link KlarnaEncoding PNO Encoding} constant. * * @link http://integration.klarna.com/en/api/standard-integration/functions * /hasaccount * * @throws KlarnaException * @return bool True, if customer has an account. */ public function hasAccount($pno, $encoding = null) { //Get the PNO/SSN encoding constant. if ($encoding === null) { $encoding = $this->getPNOEncoding(); } $this->_checkPNO($pno, $encoding); $digest = self::digest( $this->colon($this->_eid, $pno, $this->_secret) ); $paramList = array( $this->_eid, $pno, $digest, $encoding ); self::printDebug('has_account', $paramList); $result = $this->xmlrpc_call('has_account', $paramList); return ($result === 'true'); } /** * Adds an article number and quantity to be used in * {@link Klarna::activatePart()}, {@link Klarna::creditPart()} * and {@link Klarna::invoicePartAmount()}. * * @param int $qty Quantity of specified article. * @param string $artNo Article number. * * @link http://integration.klarna.com/en/api/invoice-handling-functions/ * functions/mkartno * * @throws KlarnaException * @return void */ public function addArtNo($qty, $artNo) { $this->_checkQty($qty); $this->_checkArtNo($artNo); if (!is_array($this->artNos)) { $this->artNos = array(); } $this->artNos[] = array('artno' => $artNo, 'qty' => $qty); } /** * Partially activates a passive invoice. * * Returned array contains index "url" and "invno".
* The value of "url" is a URL pointing to a temporary PDF-version of the * activated invoice.
* The value of "invno" is either 0 if the entire invoice was activated or * the number on the new passive invoice.
* * Note:
* You need to call {@link Klarna::addArtNo()} first, to specify which * articles and how many you want to partially activate.
* If you want to change the shipment type, you can specify it using: * {@link Klarna::setShipmentInfo() setShipmentInfo('delay_adjust', ...)} * with either: {@link KlarnaFlags::NORMAL_SHIPMENT NORMAL_SHIPMENT} * or {@link KlarnaFlags::EXPRESS_SHIPMENT EXPRESS_SHIPMENT} * * @param string $invNo Invoice numbers. * @param int $pclass PClass id used for this invoice. * @param bool $clear Whether customer info should be cleared after * this call. * * @see Klarna::addArtNo() * @see Klarna::activateInvoice() * @link http://integration.klarna.com/en/api/standard-integration/functions * /activatepart * * @throws KlarnaException * @return array An array with invoice URL and invoice number. * ['url' => val, 'invno' => val] */ public function activatePart( $invNo, $pclass = KlarnaPClass::INVOICE, $clear = true ) { $this->_checkInvNo($invNo); $this->_checkArtNos($this->artNos); self::printDebug('activate_part artNos array', $this->artNos); //function activate_part_digest $string = $this->_eid . ":" . $invNo . ":"; foreach ($this->artNos as $artNo) { $string .= $artNo["artno"] . ":". $artNo["qty"] . ":"; } $digestSecret = self::digest($string . $this->_secret); //end activate_part_digest $paramList = array( $this->_eid, $invNo, $this->artNos, $digestSecret, $pclass, $this->shipInfo ); self::printDebug('activate_part array', $paramList); $result = $this->xmlrpc_call('activate_part', $paramList); if ($clear === true) { $this->clear(); } self::printDebug('activate_part result', $result); return $result; } /** * Retrieves the total amount for an active invoice. * * @param string $invNo Invoice number. * * @link http://integration.klarna.com/en/api/other-functions/functions * /invoiceamount * * @throws KlarnaException * @return float The total amount. */ public function invoiceAmount($invNo) { $this->_checkInvNo($invNo); $digestSecret = self::digest( $this->colon($this->_eid, $invNo, $this->_secret) ); $paramList = array( $this->_eid, $invNo, $digestSecret ); self::printDebug('invoice_amount array', $paramList); $result = $this->xmlrpc_call('invoice_amount', $paramList); //Result is in cents, fix it. return ($result / 100); } /** * Changes the order number of a purchase that was set when the order was * made online. * * @param string $invNo Invoice number. * @param string $orderid Estores order number. * * @link http://integration.klarna.com/en/api/other-functions/functions * /updateorderno * * @throws KlarnaException * @return string Invoice number. */ public function updateOrderNo($invNo, $orderid) { $this->_checkInvNo($invNo); $this->_checkEstoreOrderNo($orderid); $digestSecret = self::digest( $this->colon($invNo, $orderid, $this->_secret) ); $paramList = array( $this->_eid, $digestSecret, $invNo, $orderid ); self::printDebug('update_orderno array', $paramList); $result = $this->xmlrpc_call('update_orderno', $paramList); return $result; } /** * Sends an activated invoice to the customer via e-mail.
* The email is sent in plain text format and contains a link to a * PDF-invoice.
* * Please note!
* Regular postal service is used if the customer has not entered his/her * e-mail address when making the purchase (charges may apply).
* * @param string $invNo Invoice number. * * @link http://integration.klarna.com/en/api/invoice-handling-functions * /functions/emailinvoice * * @throws KlarnaException * @return string Invoice number. */ public function emailInvoice($invNo) { $this->_checkInvNo($invNo); $digestSecret = self::digest( $this->colon($this->_eid, $invNo, $this->_secret) ); $paramList = array( $this->_eid, $invNo, $digestSecret ); self::printDebug('email_invoice array', $paramList); return $this->xmlrpc_call('email_invoice', $paramList); } /** * Requests a postal send-out of an activated invoice to a customer by * Klarna (charges may apply). * * @param string $invNo Invoice number. * * @link http://integration.klarna.com/en/api/invoice-handling-functions * /functions/sendinvoice * * @throws KlarnaException * @return string Invoice number. */ public function sendInvoice($invNo) { $this->_checkInvNo($invNo); $digestSecret = self::digest( $this->colon($this->_eid, $invNo, $this->_secret) ); $paramList = array( $this->_eid, $invNo, $digestSecret ); self::printDebug('send_invoice array', $paramList); return $this->xmlrpc_call('send_invoice', $paramList); } /** * Gives discounts on invoices.
* If you are using standard integration and the purchase is not yet * activated (you have not yet delivered the goods),
* just change the article list in our online interface Klarna Online.
* * Flags can be:
* {@link KlarnaFlags::INC_VAT}
* {@link KlarnaFlags::NO_FLAG}, NOT RECOMMENDED!
* * @param string $invNo Invoice number. * @param int $amount The amount given as a discount. * @param float $vat VAT in percent, e.g. 22.2 for 22.2%. * @param int $flags If amount is * {@link KlarnaFlags::INC_VAT including} or * {@link KlarnaFlags::NO_FLAG excluding} VAT. * @param string $description Optional custom text to present as discount * in the invoice. * * @link http://integration.klarna.com/en/api/invoice-handling-functions * /functions/returnamount * * @throws KlarnaException * @return string Invoice number. */ public function returnAmount( $invNo, $amount, $vat, $flags = KlarnaFlags::INC_VAT, $description = "" ) { $this->_checkInvNo($invNo); $this->_checkAmount($amount); $this->_checkVAT($vat); $this->_checkInt($flags, 'flags'); if ($description == null) { $description = ""; } $digestSecret = self::digest( $this->colon($this->_eid, $invNo, $this->_secret) ); $paramList = array( $this->_eid, $invNo, $amount, $vat, $digestSecret, $flags, $description ); self::printDebug('return_amount', $paramList); return $this->xmlrpc_call('return_amount', $paramList); } /** * Performs a complete refund on an invoice, part payment and mobile * purchase. * * @param string $invNo Invoice number. * @param string $credNo Credit number. * * @link http://integration.klarna.com/en/api/invoice-handling-functions * /functions/creditinvoice * * @throws KlarnaException * @return string Invoice number. */ public function creditInvoice($invNo, $credNo = "") { $this->_checkInvNo($invNo); $this->_checkCredNo($credNo); $digestSecret = self::digest( $this->colon($this->_eid, $invNo, $this->_secret) ); $paramList = array( $this->_eid, $invNo, $credNo, $digestSecret ); self::printDebug('credit_invoice', $paramList); return $this->xmlrpc_call('credit_invoice', $paramList); } /** * Performs a partial refund on an invoice, part payment or mobile purchase. * * Note:
* You need to call {@link Klarna::addArtNo()} first.
* * @param string $invNo Invoice number. * @param string $credNo Credit number. * * @see Klarna::addArtNo() * @link http://integration.klarna.com/en/api/invoice-handling-functions * /functions/creditpart * * @throws KlarnaException * @return string Invoice number. */ public function creditPart($invNo, $credNo = "") { $this->_checkInvNo($invNo); $this->_checkCredNo($credNo); if ($this->goodsList === null || empty($this->goodsList)) { $this->_checkArtNos($this->artNos); } //function activate_part_digest $string = $this->_eid . ":" . $invNo . ":"; if ($this->artNos !== null && !empty($this->artNos)) { foreach ($this->artNos as $artNo) { $string .= $artNo["artno"] . ":". $artNo["qty"] . ":"; } } $digestSecret = self::digest($string . $this->_secret); //end activate_part_digest $paramList = array( $this->_eid, $invNo, $this->artNos, $credNo, $digestSecret ); if ($this->goodsList !== null && !empty($this->goodsList)) { $paramList[] = 0; $paramList[] = $this->goodsList; } $this->artNos = array(); self::printDebug('credit_part', $paramList); return $this->xmlrpc_call('credit_part', $paramList); } /** * Changes the quantity of a specific item in a passive invoice. * * @param string $invNo Invoice number. * @param string $artNo Article number. * @param int $qty Quantity of specified article. * * @link http://integration.klarna.com/en/api/other-functions/functions * /updategoodsqty * * @throws KlarnaException * @return string Invoice number. */ public function updateGoodsQty($invNo, $artNo, $qty) { $this->_checkInvNo($invNo); $this->_checkQty($qty); $this->_checkArtNo($artNo); $digestSecret = self::digest( $this->colon($invNo, $artNo, $qty, $this->_secret) ); $paramList = array( $this->_eid, $digestSecret, $invNo, $artNo, $qty ); self::printDebug('update_goods_qty', $paramList); return $this->xmlrpc_call('update_goods_qty', $paramList); } /** * Changes the amount of a fee (e.g. the invoice fee) in a passive invoice. * * Type can be:
* {@link KlarnaFlags::IS_SHIPMENT}
* {@link KlarnaFlags::IS_HANDLING}
* * @param string $invNo Invoice number. * @param int $type Charge type. * @param int $newAmount The new amount for the charge. * * @link http://integration.klarna.com/en/api/other-functions/functions * /updatechargeamount * * @throws KlarnaException * @return string Invoice number. */ public function updateChargeAmount($invNo, $type, $newAmount) { $this->_checkInvNo($invNo); $this->_checkInt($type, 'type'); $this->_checkAmount($newAmount); if ($type === KlarnaFlags::IS_SHIPMENT) { $type = 1; } else if ($type === KlarnaFlags::IS_HANDLING) { $type = 2; } $digestSecret = self::digest( $this->colon($invNo, $type, $newAmount, $this->_secret) ); $paramList = array( $this->_eid, $digestSecret, $invNo, $type, $newAmount ); self::printDebug('update_charge_amount', $paramList); return $this->xmlrpc_call('update_charge_amount', $paramList); } /** * The invoice_address function is used to retrieve the address of a * purchase. * * @param string $invNo Invoice number. * * @link http://integration.klarna.com/en/api/other-functions/functions * /invoiceaddress * * @throws KlarnaException * @return KlarnaAddr */ public function invoiceAddress($invNo) { $this->_checkInvNo($invNo); $digestSecret = self::digest( $this->colon($this->_eid, $invNo, $this->_secret) ); $paramList = array( $this->_eid, $invNo, $digestSecret ); self::printDebug('invoice_address', $paramList); $result = $this->xmlrpc_call('invoice_address', $paramList); $addr = new KlarnaAddr(); if (strlen($result[0]) > 0) { $addr->isCompany = false; $addr->setFirstName($result[0]); $addr->setLastName($result[1]); } else { $addr->isCompany = true; $addr->setCompanyName($result[1]); } $addr->setStreet($result[2]); $addr->setZipCode($result[3]); $addr->setCity($result[4]); $addr->setCountry($result[5]); return $addr; } /** * Retrieves the amount of a specific goods from a purchase. * * Note:
* You need to call {@link Klarna::addArtNo()} first.
* * @param string $invNo Invoice number. * * @link http://integration.klarna.com/en/api/other-functions/functions * /invoicepartamount * @see Klarna::addArtNo() * * @throws KlarnaException * @return float The amount of the goods. */ public function invoicePartAmount($invNo) { $this->_checkInvNo($invNo); $this->_checkArtNos($this->artNos); //function activate_part_digest $string = $this->_eid . ":" . $invNo . ":"; foreach ($this->artNos as $artNo) { $string .= $artNo["artno"] . ":". $artNo["qty"] . ":"; } $digestSecret = self::digest($string . $this->_secret); //end activate_part_digest $paramList = array( $this->_eid, $invNo, $this->artNos, $digestSecret ); $this->artNos = array(); self::printDebug('invoice_part_amount', $paramList); $result = $this->xmlrpc_call('invoice_part_amount', $paramList); return ($result / 100); } /** * Returns the current order status for a specific reservation or invoice. * Use this when {@link Klarna::addTransaction()} or * {@link Klarna::reserveAmount()} returns a {@link KlarnaFlags::PENDING} * status. * * Order status can be:
* {@link KlarnaFlags::ACCEPTED}
* {@link KlarnaFlags::PENDING}
* {@link KlarnaFlags::DENIED}
* * @param string $id Reservation number or invoice number. * @param int $type 0 if $id is an invoice or reservation, 1 for order id * * @link http://integration.klarna.com/en/api/other-functions/functions * /checkorderstatus * * @throws KlarnaException * @return string The order status. */ public function checkOrderStatus($id, $type = 0) { $this->_checkArgument($id, "id"); $this->_checkInt($type, 'type'); if ($type !== 0 && $type !== 1) { throw new Klarna_InvalidTypeException( 'type', "0 or 1" ); } $digestSecret = self::digest( $this->colon($this->_eid, $id, $this->_secret) ); $paramList = array( $this->_eid, $digestSecret, $id, $type ); self::printDebug('check_order_status', $paramList); return $this->xmlrpc_call('check_order_status', $paramList); } /** * Retrieves a list of all the customer numbers associated with the * specified pno. * * @param string $pno Social security number, Personal number, ... * @param int $encoding {@link KlarnaEncoding PNO Encoding} constant. * * @throws KlarnaException * @return array An array containing all customer numbers associated * with that pno. */ public function getCustomerNo($pno, $encoding = null) { //Get the PNO/SSN encoding constant. if ($encoding === null) { $encoding = $this->getPNOEncoding(); } $this->_checkPNO($pno, $encoding); $digestSecret = self::digest( $this->colon($this->_eid, $pno, $this->_secret) ); $paramList = array( $pno, $this->_eid, $digestSecret, $encoding ); self::printDebug('get_customer_no', $paramList); return $this->xmlrpc_call('get_customer_no', $paramList); } /** * Associates a pno with a customer number when you want to make future * purchases without a pno. * * @param string $pno Social security number, Personal number, ... * @param string $custNo The customer number. * @param int $encoding {@link KlarnaEncoding PNO Encoding} constant. * * @throws KlarnaException * @return bool True, if the customer number was associated with the pno. */ public function setCustomerNo($pno, $custNo, $encoding = null) { //Get the PNO/SSN encoding constant. if ($encoding === null) { $encoding = $this->getPNOEncoding(); } $this->_checkPNO($pno, $encoding); $this->_checkArgument($custNo, 'custNo'); $digestSecret = self::digest( $this->colon($this->_eid, $pno, $custNo, $this->_secret) ); $paramList = array( $pno, $custNo, $this->_eid, $digestSecret, $encoding ); self::printDebug('set_customer_no', $paramList); $result = $this->xmlrpc_call('set_customer_no', $paramList); return ($result == 'ok'); } /** * Removes a customer number from association with a pno. * * @param string $custNo The customer number. * * @throws KlarnaException * @return bool True, if the customer number association was removed. */ public function removeCustomerNo($custNo) { $this->_checkArgument($custNo, 'custNo'); $digestSecret = self::digest( $this->colon($this->_eid, $custNo, $this->_secret) ); $paramList = array( $custNo, $this->_eid, $digestSecret ); self::printDebug('remove_customer_no', $paramList); $result = $this->xmlrpc_call('remove_customer_no', $paramList); return ($result == 'ok'); } /** * Sets notes/log information for the specified invoice number. * * @param string $invNo Invoice number. * @param string $notes Note(s) to be associated with the invoice. * * @throws KlarnaException * @return string Invoice number. */ public function updateNotes($invNo, $notes) { $this->_checkInvNo($invNo); if (!is_string($notes)) { $notes = strval($notes); } $digestSecret = self::digest( $this->colon($invNo, $notes, $this->_secret) ); $paramList = array( $this->_eid, $digestSecret, $invNo, $notes ); self::printDebug('update_notes', $paramList); return $this->xmlrpc_call('update_notes', $paramList); } /** * Returns the configured PCStorage object. * * @throws Exception|KlarnaException * @return PCStorage */ public function getPCStorage() { if (isset($this->pclasses)) { return $this->pclasses; } include_once 'pclasses/storage.intf.php'; $className = $this->pcStorage.'storage'; $pclassStorage = dirname(__FILE__) . "/pclasses/{$className}.class.php"; include_once $pclassStorage; $storage = new $className; if (!($storage instanceof PCStorage)) { throw new Klarna_PCStorageInvalidException( $className, $pclassStorage ); } return $storage; } /** * Fetch pclasses * * @param PCStorage $storage PClass Storage * @param int $country KlarnaCountry constant * @param int $language KlarnaLanguage constant * @param int $currency KlarnaCurrency constant * * @return void */ private function _fetchPClasses($storage, $country, $language, $currency) { $digestSecret = self::digest( $this->_eid . ":" . $currency . ":" . $this->_secret ); $paramList = array( $this->_eid, $currency, $digestSecret, $country, $language ); self::printDebug('get_pclasses array', $paramList); $result = $this->xmlrpc_call('get_pclasses', $paramList); self::printDebug('get_pclasses result', $result); foreach ($result as &$pclass) { //numeric htmlentities $pclass[1] = Klarna::num_htmlentities($pclass[1]); //Below values are in "cents", fix them. $pclass[3] /= 100; //divide start fee with 100 $pclass[4] /= 100; //divide invoice fee with 100 $pclass[5] /= 100; //divide interest rate with 100 $pclass[6] /= 100; //divide min amount with 100 if ($pclass[9] != '-') { //unix timestamp instead of yyyy-mm-dd $pclass[9] = strtotime($pclass[9]); } //Associate the PClass with this estore. array_unshift($pclass, $this->_eid); $storage->addPClass(new KlarnaPClass($pclass)); } } /** * Fetches the PClasses from Klarna Online.
* Removes the cached/stored pclasses and updates.
* You are only allowed to call this once, or once per update of PClasses * in KO.
* * Note:
* If language and/or currency is null, then they will be set to mirror * the specified country.
* Short codes like DE, SV or EUR can also be used instead of the constants. * * @param string|int $country {@link KlarnaCountry Country} constant, * or two letter code. * @param mixed $language {@link KlarnaLanguage Language} constant, * or two letter code. * @param mixed $currency {@link KlarnaCurrency Currency} constant, * or three letter code. * * @throws KlarnaException * @return void */ public function fetchPClasses( $country = null, $language = null, $currency = null ) { extract( $this->getLocale($country, $language, $currency), EXTR_OVERWRITE ); $this->_checkConfig(); $pclasses = $this->getPCStorage(); try { //Attempt to load previously stored pclasses, so they aren't // accidentially removed. $pclasses->load($this->pcURI); } catch(Exception $e) { self::printDebug('load pclasses', $e->getMessage()); } $this->_fetchPClasses($pclasses, $country, $language, $currency); $pclasses->save($this->pcURI); $this->pclasses = $pclasses; } /** * Removes the stored PClasses, if you need to update them. * * @throws KlarnaException * @return void */ public function clearPClasses() { $this->_checkConfig(); $pclasses = $this->getPCStorage(); $pclasses->clear($this->pcURI); } /** * Retrieves the specified PClasses. * * Type can be:
* {@link KlarnaPClass::CAMPAIGN}
* {@link KlarnaPClass::ACCOUNT}
* {@link KlarnaPClass::SPECIAL}
* {@link KlarnaPClass::FIXED}
* {@link KlarnaPClass::DELAY}
* {@link KlarnaPClass::MOBILE}
* * @param int $type PClass type identifier. * * @throws KlarnaException * @return array An array of PClasses. [KlarnaPClass] */ public function getPClasses($type = null) { $this->_checkConfig(); if (!$this->pclasses) { $this->pclasses = $this->getPCStorage(); $this->pclasses->load($this->pcURI); } $tmp = $this->pclasses->getPClasses( $this->_eid, $this->_country, $type ); $this->sortPClasses($tmp[$this->_eid]); return $tmp[$this->_eid]; } /** * Retrieve a flattened array of all pclasses stored in the configured * pclass storage. * * @return array */ public function getAllPClasses() { if (!$this->pclasses) { $this->pclasses = $this->getPCStorage(); $this->pclasses->load($this->pcURI); } return $this->pclasses->getAllPClasses(); } /** * Returns the specified PClass. * * @param int $id The PClass ID. * * @return KlarnaPClass */ public function getPClass($id) { if (!is_numeric($id)) { throw new Klarna_InvalidTypeException('id', 'integer'); } $this->_checkConfig(); if (!$this->pclasses || !($this->pclasses instanceof PCStorage)) { $this->pclasses = $this->getPCStorage(); $this->pclasses->load($this->pcURI); } return $this->pclasses->getPClass( intval($id), $this->_eid, $this->_country ); } /** * Sorts the specified array of KlarnaPClasses. * * @param array &$array An array of {@link KlarnaPClass PClasses}. * * @return void */ public function sortPClasses(&$array) { if (!is_array($array)) { //Input is not an array! $array = array(); return; } //Sort pclasses array after natural sort (natcmp) if (!function_exists('pcCmp')) { /** * Comparison function * * @param KlarnaPClass $a object 1 * @param KlarnaPClass $b object 2 * * @return int */ function pcCmp($a, $b) { if ($a->getDescription() == null && $b->getDescription() == null ) { return 0; } else if ($a->getDescription() == null) { return 1; } else if ($b->getDescription() == null) { return -1; } else if ($b->getType() === 2 && $a->getType() !== 2) { return 1; } else if ($b->getType() !== 2 && $a->getType() === 2) { return -1; } return strnatcmp($a->getDescription(), $b->getDescription())*-1; } } usort($array, "pcCmp"); } /** * Returns the cheapest, per month, PClass related to the specified sum. * * Note: This choose the cheapest PClass for the current country.
* {@link Klarna::setCountry()} * * Flags can be:
* {@link KlarnaFlags::CHECKOUT_PAGE}
* {@link KlarnaFlags::PRODUCT_PAGE}
* * @param float $sum The product cost, or total sum of the cart. * @param int $flags Which type of page the info will be displayed on. * * @throws KlarnaException * @return KlarnaPClass or false if none was found. */ public function getCheapestPClass($sum, $flags) { if (!is_numeric($sum)) { throw new Klarna_InvalidPriceException($sum); } if (!is_numeric($flags) || !in_array( $flags, array( KlarnaFlags::CHECKOUT_PAGE, KlarnaFlags::PRODUCT_PAGE) ) ) { throw new Klarna_InvalidTypeException( 'flags', KlarnaFlags::CHECKOUT_PAGE . ' or ' . KlarnaFlags::PRODUCT_PAGE ); } $lowest_pp = $lowest = false; foreach ($this->getPClasses() as $pclass) { $lowest_payment = KlarnaCalc::get_lowest_payment_for_account( $pclass->getCountry() ); if ($pclass->getType() < 2 && $sum >= $pclass->getMinAmount()) { $minpay = KlarnaCalc::calc_monthly_cost( $sum, $pclass, $flags ); if ($minpay < $lowest_pp || $lowest_pp === false) { if ($pclass->getType() == KlarnaPClass::ACCOUNT || $minpay >= $lowest_payment ) { $lowest_pp = $minpay; $lowest = $pclass; } } } } return $lowest; } /** * Initializes the checkoutHTML objects. * * @see Klarna::checkoutHTML() * @return void */ protected function initCheckout() { $dir = dirname(__FILE__); //Require the CheckoutHTML interface/abstract class include_once $dir.'/checkout/checkouthtml.intf.php'; //Iterate over all .class.php files in checkout/ foreach (glob($dir.'/checkout/*.class.php') as $checkout) { if (!self::$debug) { ob_start(); } include_once $checkout; $className = basename($checkout, '.class.php'); $cObj = new $className; if ($cObj instanceof CheckoutHTML) { $cObj->init($this, $this->_eid); $this->coObjects[$className] = $cObj; } if (!self::$debug) { ob_end_clean(); } } } /** * Returns the checkout page HTML from the checkout classes. * * Note:
* This method uses output buffering to silence unwanted echoes.
* * @see CheckoutHTML * * @return string A HTML string. */ public function checkoutHTML() { if (empty($this->coObjects)) { $this->initCheckout(); } $dir = dirname(__FILE__); //Require the CheckoutHTML interface/abstract class include_once $dir.'/checkout/checkouthtml.intf.php'; //Iterate over all .class.php files in $html = "\n"; foreach ($this->coObjects as $cObj) { if (!self::$debug) { ob_start(); } if ($cObj instanceof CheckoutHTML) { $html .= $cObj->toHTML() . "\n"; } if (!self::$debug) { ob_end_clean(); } } return $html; } /** * Creates a XMLRPC call with specified XMLRPC method and parameters from array. * * @param string $method XMLRPC method. * @param array $array XMLRPC parameters. * * @throws KlarnaException * @return mixed */ protected function xmlrpc_call($method, $array) { $this->_checkConfig(); if (!isset($method) || !is_string($method)) { throw new Klarna_InvalidTypeException('method', 'string'); } if ($array === null || count($array) === 0) { throw new KlarnaException("Parameterlist is empty or null!", 50067); } if (self::$disableXMLRPC) { return true; } try { /* * Disable verifypeer for CURL, so below error is avoided. * CURL error: SSL certificate problem, verify that the CA * cert is OK. * Details: error:14090086:SSL * routines:SSL3_GET_SERVER_CERTIFICATE:certificate verify failed (#8) */ $this->xmlrpc->verifypeer = false; $timestart = microtime(true); //Create the XMLRPC message. $msg = new xmlrpcmsg($method); $params = array_merge( array( $this->PROTO, $this->VERSION ), $array ); $msg = new xmlrpcmsg($method); foreach ($params as $p) { if (!$msg->addParam( php_xmlrpc_encode($p, array('extension_api')) ) ) { throw new KlarnaException( "Failed to add parameters to XMLRPC message.", 50068 ); } } //Send the message. $selectDateTime = microtime(true); if (self::$xmlrpcDebug) { $this->xmlrpc->setDebug(2); } $xmlrpcresp = $this->xmlrpc->send($msg); //Calculate time and selectTime. $timeend = microtime(true); $time = (int) (($selectDateTime - $timestart) * 1000); $selectTime = (int) (($timeend - $timestart) * 1000); $status = $xmlrpcresp->faultCode(); //Send report to candice. if (self::$_candice === true) { $this->sendStat($method, $time, $selectTime, $status); } if ($status !== 0) { throw new KlarnaException($xmlrpcresp->faultString(), $status); } return php_xmlrpc_decode($xmlrpcresp->value()); } catch(KlarnaException $e) { //Otherwise it is caught below, and rethrown. throw $e; } catch(Exception $e) { throw new KlarnaException($e->getMessage(), $e->getCode()); } } /** * Removes all relevant order/customer data from the internal structure. * * @return void */ public function clear() { $this->goodsList = null; $this->comment = ""; $this->billing = null; $this->shipping = null; $this->shipInfo = array(); $this->extraInfo = array(); $this->bankInfo = array(); $this->incomeInfo = array(); $this->activateInfo = array(); $this->reference = ""; $this->reference_code = ""; $this->orderid[0] = ""; $this->orderid[1] = ""; $this->artNos = array(); $this->coObjects = array(); } /** * Sends a report to Candice. * * @param string $method XMLRPC method. * @param int $time Elapsed time of entire XMLRPC call. * @param int $selectTime Time to create the XMLRPC parameters. * @param int $status XMLRPC error code. * * @return void */ protected function sendStat($method, $time, $selectTime, $status) { $fp = @fsockopen('udp://'.self::$_c_addr, 80, $errno, $errstr, 1500); if ($fp) { $uri = "{$this->_url['scheme']}://{$this->_url['host']}" . ":{$this->_url['port']}"; $data = $this->pipe( $this->_eid, $method, $time, $selectTime, $status, $uri ); $digest = self::digest($this->pipe($data, $this->_secret)); self::printDebug("candice report", $data); @fwrite($fp, $this->pipe($data, $digest)); @fclose($fp); } } /** * Implodes parameters with delimiter ':'. * Null and "" values are ignored by the colon function to * ensure there is not several colons in succession. * * @return string Colon separated string. */ public static function colon(/* variable parameters */) { return implode( ':', array_filter( func_get_args(), array('self', 'filterDigest') ) ); } /** * Implodes parameters with delimiter '|'. * * @return string Pipe separated string. */ public static function pipe(/* variable parameters */) { $args = func_get_args(); return implode('|', $args); } /** * Check if the value has a string length larger than 0 * * @param mixed $value The value to check. * * @return boolean True if string length is larger than 0 */ public static function filterDigest($value) { return strlen(strval($value)) > 0; } /** * Creates a digest hash from the inputted string, * and the specified or the preferred hash algorithm. * * @param string $data Data to be hashed. * @param string $hash hash algoritm to use * * @throws KlarnaException * @return string Base64 encoded hash. */ public static function digest($data, $hash = null) { if ($hash===null) { $preferred = array( 'sha512', 'sha384', 'sha256', 'sha224', 'md5' ); $hashes = array_intersect($preferred, hash_algos()); if (count($hashes) == 0) { throw new KlarnaException( "No available hash algorithm supported!" ); } $hash = array_shift($hashes); } self::printDebug('digest() using hash', $hash); return base64_encode(pack("H*", hash($hash, $data))); } /** * Converts special characters to numeric htmlentities. * * Note:
* If supplied string is encoded with UTF-8, o umlaut ("ö") will become two * HTML entities instead of one. * * @param string $str String to be converted. * * @return string String converted to numeric HTML entities. */ public static function num_htmlentities($str) { if (!self::$htmlentities) { self::$htmlentities = array(); $table = get_html_translation_table(HTML_ENTITIES, ENT_QUOTES); foreach ($table as $char => $entity) { self::$htmlentities[$entity] = '&#' . ord($char) . ';'; } } return str_replace( array_keys( self::$htmlentities ), self::$htmlentities, htmlentities($str) ); } /** * Prints debug information if debug is set to true. * $msg is used as header/footer in the output. * * if FirePHP is available it will be used instead of * dumping the debug info into the document. * * It uses print_r and encapsulates it in HTML/XML comments. * () * * @param string $msg Debug identifier, e.g. "my array". * @param mixed $mixed Object, type, etc, to be debugged. * * @return void */ public static function printDebug($msg, $mixed) { if (self::$debug) { if (class_exists('FB', false)) { FB::send($mixed, $msg); } else { echo "\n\n"; } } } /** * Checks/fixes so the invNo input is valid. * * @param string &$invNo Invoice number. * * @throws KlarnaException * @return void */ private function _checkInvNo(&$invNo) { if (!isset($invNo)) { throw new Klarna_ArgumentNotSetException("Invoice number"); } if (!is_string($invNo)) { $invNo = strval($invNo); } if (strlen($invNo) == 0) { throw new Klarna_ArgumentNotSetException("Invoice number"); } } /** * Checks/fixes so the quantity input is valid. * * @param int &$qty Quantity. * * @throws KlarnaException * @return void */ private function _checkQty(&$qty) { if (!isset($qty)) { throw new Klarna_ArgumentNotSetException("Quantity"); } if (is_numeric($qty) && !is_int($qty)) { $qty = intval($qty); } if (!is_int($qty)) { throw new Klarna_InvalidTypeException("Quantity", "integer"); } } /** * Checks/fixes so the artTitle input is valid. * * @param string &$artTitle Article title. * * @throws KlarnaException * @return void */ private function _checkArtTitle(&$artTitle) { if (!is_string($artTitle)) { $artTitle = strval($artTitle); } if (!isset($artTitle) || strlen($artTitle) == 0) { throw new Klarna_ArgumentNotSetException("artTitle", 50059); } } /** * Checks/fixes so the artNo input is valid. * * @param int|string &$artNo Article number. * * @throws KlarnaException * @return void */ private function _checkArtNo(&$artNo) { if (is_numeric($artNo) && !is_string($artNo)) { //Convert artNo to string if integer. $artNo = strval($artNo); } if (!isset($artNo) || strlen($artNo) == 0 || (!is_string($artNo))) { throw new Klarna_ArgumentNotSetException("artNo"); } } /** * Checks/fixes so the credNo input is valid. * * @param string &$credNo Credit number. * * @throws KlarnaException * @return void */ private function _checkCredNo(&$credNo) { if (!isset($credNo)) { throw new Klarna_ArgumentNotSetException("Credit number"); } if ($credNo === false || $credNo === null) { $credNo = ""; } if (!is_string($credNo)) { $credNo = strval($credNo); if (!is_string($credNo)) { throw new Klarna_InvalidTypeException("Credit number", "string"); } } } /** * Checks so that artNos is an array and is not empty. * * @param array &$artNos Array from {@link Klarna::addArtNo()}. * * @throws KlarnaException * @return void */ private function _checkArtNos(&$artNos) { if (!is_array($artNos)) { throw new Klarna_InvalidTypeException("artNos", "array"); } if (empty($artNos)) { throw new KlarnaException('ArtNo array is empty!', 50064); } } /** * Checks/fixes so the integer input is valid. * * @param int &$int {@link KlarnaFlags flags} constant. * @param string $field Name of the field. * * @throws KlarnaException * @return void */ private function _checkInt(&$int, $field) { if (!isset($int)) { throw new Klarna_ArgumentNotSetException($field); } if (is_numeric($int) && !is_int($int)) { $int = intval($int); } if (!is_numeric($int) || !is_int($int)) { throw new Klarna_InvalidTypeException($field, "integer"); } } /** * Checks/fixes so the VAT input is valid. * * @param float &$vat VAT. * * @throws KlarnaException * @return void */ private function _checkVAT(&$vat) { if (!isset($vat)) { throw new Klarna_ArgumentNotSetException("VAT"); } if (is_numeric($vat) && (!is_int($vat) || !is_float($vat))) { $vat = floatval($vat); } if (!is_numeric($vat) || (!is_int($vat) && !is_float($vat))) { throw new Klarna_InvalidTypeException("VAT", "integer or float"); } } /** * Checks/fixes so the amount input is valid. * * @param int &$amount Amount. * * @throws KlarnaException * @return void */ private function _checkAmount(&$amount) { if (!isset($amount)) { throw new Klarna_ArgumentNotSetException("Amount"); } if (is_numeric($amount)) { $this->_fixValue($amount); } if (is_numeric($amount) && !is_int($amount)) { $amount = intval($amount); } if (!is_numeric($amount) || !is_int($amount)) { throw new Klarna_InvalidTypeException("amount", "integer"); } } /** * Checks/fixes so the price input is valid. * * @param int &$price Price. * * @throws KlarnaException * @return void */ private function _checkPrice(&$price) { if (!isset($price)) { throw new Klarna_ArgumentNotSetException("Price"); } if (is_numeric($price)) { $this->_fixValue($price); } if (is_numeric($price) && !is_int($price)) { $price = intval($price); } if (!is_numeric($price) || !is_int($price)) { throw new Klarna_InvalidTypeException("Price", "integer"); } } /** * Multiplies value with 100 and rounds it. * This fixes value/price/amount inputs so that KO can handle them. * * @param float &$value value * * @return void */ private function _fixValue(&$value) { $value = round($value * 100); } /** * Checks/fixes so the discount input is valid. * * @param float &$discount Discount amount. * * @throws KlarnaException * @return void */ private function _checkDiscount(&$discount) { if (!isset($discount)) { throw new Klarna_ArgumentNotSetException("Discount"); } if (is_numeric($discount) && (!is_int($discount) || !is_float($discount)) ) { $discount = floatval($discount); } if (!is_numeric($discount) || (!is_int($discount) && !is_float($discount)) ) { throw new Klarna_InvalidTypeException("Discount", "integer or float"); } } /** * Checks/fixes so that the estoreOrderNo input is valid. * * @param string &$estoreOrderNo Estores order number. * * @throws KlarnaException * @return void */ private function _checkEstoreOrderNo(&$estoreOrderNo) { if (!isset($estoreOrderNo)) { throw new Klarna_ArgumentNotSetException("Order number"); } if (!is_string($estoreOrderNo)) { $estoreOrderNo = strval($estoreOrderNo); if (!is_string($estoreOrderNo)) { throw new Klarna_InvalidTypeException("Order number", "string"); } } } /** * Checks/fixes to the PNO/SSN input is valid. * * @param string &$pno Personal number, social security number, ... * @param int $enc {@link KlarnaEncoding PNO Encoding} constant. * * @throws KlarnaException * @return void */ private function _checkPNO(&$pno, $enc) { if (!$pno) { throw new Klarna_ArgumentNotSetException("PNO/SSN"); } if (!KlarnaEncoding::checkPNO($pno)) { throw new Klarna_InvalidPNOException; } } /** * Checks/fixes to the country input is valid. * * @param int &$country {@link KlarnaCountry Country} constant. * * @throws KlarnaException * @return void */ private function _checkCountry(&$country) { if (!isset($country)) { throw new Klarna_ArgumentNotSetException("Country"); } if (is_numeric($country) && !is_int($country)) { $country = intval($country); } if (!is_numeric($country) || !is_int($country)) { throw new Klarna_InvalidTypeException("Country", "integer"); } } /** * Checks/fixes to the language input is valid. * * @param int &$language {@link KlarnaLanguage Language} constant. * * @throws KlarnaException * @return void */ private function _checkLanguage(&$language) { if (!isset($language)) { throw new Klarna_ArgumentNotSetException("Language"); } if (is_numeric($language) && !is_int($language)) { $language = intval($language); } if (!is_numeric($language) || !is_int($language)) { throw new Klarna_InvalidTypeException("Language", "integer"); } } /** * Checks/fixes to the currency input is valid. * * @param int &$currency {@link KlarnaCurrency Currency} constant. * * @throws KlarnaException * @return void */ private function _checkCurrency(&$currency) { if (!isset($currency)) { throw new Klarna_ArgumentNotSetException("Currency"); } if (is_numeric($currency) && !is_int($currency)) { $currency = intval($currency); } if (!is_numeric($currency) || !is_int($currency)) { throw new Klarna_InvalidTypeException("Currency", "integer"); } } /** * Checks/fixes so no/number is a valid input. * * @param int &$no Number. * * @throws KlarnaException * @return void */ private function _checkNo(&$no) { if (!isset($no)) { throw new Klarna_ArgumentNotSetException("no"); } if (is_numeric($no) && !is_int($no)) { $no = intval($no); } if (!is_numeric($no) || !is_int($no) || $no <= 0) { throw new Klarna_InvalidTypeException('no', 'integer > 0'); } } /** * Checks/fixes so reservation number is a valid input. * * @param string &$rno Reservation number. * * @throws KlarnaException * @return void */ private function _checkRNO(&$rno) { if (!is_string($rno)) { $rno = strval($rno); } if (strlen($rno) == 0) { throw new Klarna_ArgumentNotSetException("RNO"); } } /** * Checks/fixes so that reference/refCode are valid. * * @param string &$reference Reference string. * @param string &$refCode Reference code. * * @throws KlarnaException * @return void */ private function _checkRef(&$reference, &$refCode) { if (!is_string($reference)) { $reference = strval($reference); if (!is_string($reference)) { throw new Klarna_InvalidTypeException("Reference", "string"); } } if (!is_string($refCode)) { $refCode = strval($refCode); if (!is_string($refCode)) { throw new Klarna_InvalidTypeException("Reference code", "string"); } } } /** * Checks/fixes so that the OCR input is valid. * * @param string &$ocr OCR number. * * @throws KlarnaException * @return void */ private function _checkOCR(&$ocr) { if (!is_string($ocr)) { $ocr = strval($ocr); if (!is_string($ocr)) { throw new Klarna_InvalidTypeException("OCR", "string"); } } } /** * Check so required argument is supplied. * * @param string $argument argument to check * @param string $name name of argument * * @throws Klarna_ArgumentNotSetException * @return void */ private function _checkArgument($argument, $name) { if (!is_string($argument)) { $argument = strval($argument); } if (strlen($argument) == 0) { throw new Klarna_ArgumentNotSetException($name); } } /** * Check so Locale settings (country, currency, language) are set. * * @throws KlarnaException * @return void */ private function _checkLocale() { if (!is_int($this->_country) || !is_int($this->_language) || !is_int($this->_currency) ) { throw new Klarna_InvalidLocaleException; } } /** * Checks wether a goodslist is set. * * @throws Klarna_MissingGoodslistException * @return void */ private function _checkGoodslist() { if (!is_array($this->goodsList) || empty($this->goodsList)) { throw new Klarna_MissingGoodslistException; } } /** * Set the pcStorage method used for this instance * * @param PCStorage $pcStorage PCStorage implementation * * @return void */ public function setPCStorage($pcStorage) { if (!($pcStorage instanceof PCStorage)) { throw new Klarna_InvalidTypeException('pcStorage', 'PCStorage'); } $this->pcStorage = $pcStorage->getName(); $this->pclasses = $pcStorage; } /** * Ensure the configuration is of the correct type. * * @param array|ArrayAccess|null $config an optional config to validate * * @return void */ private function _checkConfig($config = null) { if ($config === null) { $config = $this->config; } if (!($config instanceof ArrayAccess) && !is_array($config) ) { throw new Klarna_IncompleteConfigurationException; } } } //End Klarna /** * Include the {@link KlarnaConfig} class. */ require_once 'klarnaconfig.php'; /** * Include the {@link KlarnaPClass} class. */ require_once 'klarnapclass.php'; /** * Include the {@link KlarnaCalc} class. */ require_once 'klarnacalc.php'; /** * Include the {@link KlarnaAddr} class. */ require_once 'klarnaaddr.php'; /** * Include the Exception classes. */ require_once 'Exceptions.php'; /** * Include the KlarnaEncoding class. */ require_once 'Encoding.php'; /** * Include the KlarnaFlags class. */ require_once 'Flags.php'; /** * Include KlarnaCountry, KlarnaCurrency, KlarnaLanguage classes */ require_once 'Country.php'; require_once 'Currency.php'; require_once 'Language.php'; CHANGELOG000066600000016025151375520470005777 0ustar00===================== Klarna PHP API ===================== v2.3.4 --------------- Date: 2013-05-03 Joakim L. Klarna.php Update beta address to payment.testdrive.klarna.com v2.3.3 --------------- Date: 2013-03-28 Rickard D. Klarna.php (reserveAmount) : No longer remove falsy values from the digest string. v2.3.2 --------------- Date: 2013-03-25 Rickard D. Klarna.php (reserveAmount) : Allow reserveAmount calls with an amount of 0. v2.3.1 --------------- Date: 2012-12-07 Christer G. Klarna.php (getClientIP) : Refactored to be more readable. Rickard D. Klarna.php (setConfig) : Configuration may now be an array, aswell as a and ArrayAccess. Majid G. Klarna.php (update) : Removed rno validation from the library v2.3.0 --------------- Date: 2012-09-17 Rickard D. Klarna.php (activateReservation) : Change to allow NULL to be sent in as PNO when activating a reservation. Any other value than null will still trigger a verification that a string longer than 0 characters is sent as PNO. Klarna.php (activate) : new function New function to activate a reservation using minimal information. Optional information for the activate call should be set using setActivateInformation. To partially activate a reservation, use Klarna::addArtNo() function (replaces splitReservation). Klarna.php (update) : new function New function to update a reservation using minimal information. Use setAddress to update address, addArticle to update an article in the goodslist and setEstoreInfo to update order id:s. Klarna.php (checkCountryCurrency) : removed function As this function does not scale and does not belong in a library it has been removed. Country.php () : Added all available country constants. Language.php () : Added all available language constants. Klarna.php (getLanguageForCountry) : deprecated (getCurrencyForCountry) : deprecated Country.php (checkLanguage) : deprecated (checkCurrency) : deprecated (getLanguage) : deprecated (getCurrency) : deprecated Deprecated functions that will not scale and will not be compatible for any potential future markets. Klarna.php (init, setCountry) : Removed the automatic setting of currency and language when setting the country. This functionality does not scale and was not consistent depending on how you set the country. Majid G. Klarna.php (addTransaction) : Removing the link comment for PRE_PAY flag Flags.php (KlarnaFlags) : Adding deprecated comment for Flag 8 (PRE_PAY) v2.2.1 ---------------- Date: 2011-05-18 David K. Klarna.php (summarizeGoodsList) New method that can be used to get a aggregated price for the entire goodslist Klarna.php (reserveAmount) Replace the simple goodslist summary that did not take taxes and discounts into consideration with a call to summarizeGoodsList v2.2.0 ---------------- Date: 2012-05-14 Rickard D. Klarna.php (assembleAddress) : Only validate that the proper object type is sent in to Klarna, no longer performs any validation of the content of the fields. klarnaaddr.php () : Removed validation of field contets. Now possible to set all fields to empty strings if you wan. Klarna.php (addTransaction, reserveAmount, activateReservation) : If $gender is sent in as an empty string, treat it as null. klarnacalc.php (calc_apr) : Removed the ability to send in a FIXED or SPECIAL pclass to KlarnaCalc->calc_apr. If this function is called with a FIXED or SPECIAL pclass it will now throw an exception instead of causing a fatal error. Klarna.php (getAllPClasses) : added storage.intf.php (getAllPClasses) : added Added possibility to get all stored pclasses, regardless of eid or type. Klarna.php (setPCStorage) : Added possibility to set a PCStorage on the Klarna object. Klarna.php (getPCStorage) : made public (was protected) Added possibility to get the configured PCStorage object from the Klarna object. Country.php (getLanguageForCountry, getCurrencyForCountry) : added Added possibility to get the language or currency for a specific country. All Files () : Updated code to follow the PEAR standard. Refactored several classes into their own files. All refactored classes were previosly declared inside the Klarna.php file. The new files are now instead included in the Klarna.php file, so no functionality has changed in that regard. KlarnaCountry => Country.php KlarnaCurrency => Currency.php KlarnaEncoding => Encoding.php KlarnaException => Exceptions.php KlarnaFlags => Flags.php KlarnaLanguage => Language.php Made almost all exceptions thrown more specific and meaningful than just KlarnaException, although they still extend KlarnaException so old try-catch blocks will still work. v2.1.3 ---------------- Date: 2011-09-26 * Fixed a minor conversion issue. v2.1.2 ---------------- Date: 2011-09-12 * Improved the MySQL and SQL storage modules Added so you can pass an associative array to pcURI with the database info Added support for dashes in the normal regexp handling Fixed a rounding bug which requires a DROP TABLE and re-update of all PClasses * Fixed a minor issue regarding the debug and xmlrpcDebug settings * Added support for the ISO 3166-1 alpha-3 country codes v2.1.1 ---------------- Date: 2011-09-06 * Corrected a few issues in the phpDoc comments * Improved fetchPClasses, it is now possible to specify only country (as code or constant) * Changed the MySQL PClass storage's clear functionality to use DELETE FROM instead of DROP TABLE, this is to prevent possible permission issues in the database * Various improvements and bug fixes v2.1.0 ---------------- Date: 2011-08-19 * Added support for stronger cryptographic hashes The default is now SHA-512 instead of MD5 * Experimental generic database storage using PDO * Added work arounds for issues with the XML-RPC library * Bug fix and additional sanity checks in getCheapestPClass * Debug mode uses FirePHP if available v2.0.0 ---------------- Date: 2011-07-01 * Initial release of 2.0 API * A complete rewrite using object oriented practices transport/xmlrpc-3.0.0.beta/index.html000066600000000037151375520470013465 0ustar00 transport/xmlrpc-3.0.0.beta/lib/xmlrpcs.inc000066600000117346151375520470014435 0ustar00 // $Id: xmlrpcs.inc,v 1.71 2008/10/29 23:41:28 ggiunta Exp $ // Copyright (c) 1999,2000,2002 Edd Dumbill. // All rights reserved. // // Redistribution and use in source and binary forms, with or without // modification, are permitted provided that the following conditions // are met: // // * Redistributions of source code must retain the above copyright // notice, this list of conditions and the following disclaimer. // // * Redistributions in binary form must reproduce the above // copyright notice, this list of conditions and the following // disclaimer in the documentation and/or other materials provided // with the distribution. // // * Neither the name of the "XML-RPC for PHP" nor the names of its // contributors may be used to endorse or promote products derived // from this software without specific prior written permission. // // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS // FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE // REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, // INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES // (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR // SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) // HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, // STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) // ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED // OF THE POSSIBILITY OF SUCH DAMAGE. // XML RPC Server class // requires: xmlrpc.inc $GLOBALS['xmlrpcs_capabilities'] = array( // xmlrpc spec: always supported 'xmlrpc' => new xmlrpcval(array( 'specUrl' => new xmlrpcval('http://www.xmlrpc.com/spec', 'string'), 'specVersion' => new xmlrpcval(1, 'int') ), 'struct'), // if we support system.xxx functions, we always support multicall, too... // Note that, as of 2006/09/17, the following URL does not respond anymore 'system.multicall' => new xmlrpcval(array( 'specUrl' => new xmlrpcval('http://www.xmlrpc.com/discuss/msgReader$1208', 'string'), 'specVersion' => new xmlrpcval(1, 'int') ), 'struct'), // introspection: version 2! we support 'mixed', too 'introspection' => new xmlrpcval(array( 'specUrl' => new xmlrpcval('http://phpxmlrpc.sourceforge.net/doc-2/ch10.html', 'string'), 'specVersion' => new xmlrpcval(2, 'int') ), 'struct') ); /* Functions that implement system.XXX methods of xmlrpc servers */ $_xmlrpcs_getCapabilities_sig=array(array($GLOBALS['xmlrpcStruct'])); $_xmlrpcs_getCapabilities_doc='This method lists all the capabilites that the XML-RPC server has: the (more or less standard) extensions to the xmlrpc spec that it adheres to'; $_xmlrpcs_getCapabilities_sdoc=array(array('list of capabilities, described as structs with a version number and url for the spec')); function _xmlrpcs_getCapabilities($server, $m=null) { $outAr = $GLOBALS['xmlrpcs_capabilities']; // NIL extension if ($GLOBALS['xmlrpc_null_extension']) { $outAr['nil'] = new xmlrpcval(array( 'specUrl' => new xmlrpcval('http://www.ontosys.com/xml-rpc/extensions.php', 'string'), 'specVersion' => new xmlrpcval(1, 'int') ), 'struct'); } return new xmlrpcresp(new xmlrpcval($outAr, 'struct')); } // listMethods: signature was either a string, or nothing. // The useless string variant has been removed $_xmlrpcs_listMethods_sig=array(array($GLOBALS['xmlrpcArray'])); $_xmlrpcs_listMethods_doc='This method lists all the methods that the XML-RPC server knows how to dispatch'; $_xmlrpcs_listMethods_sdoc=array(array('list of method names')); function _xmlrpcs_listMethods($server, $m=null) // if called in plain php values mode, second param is missing { $outAr=array(); foreach($server->dmap as $key => $val) { $outAr[]=new xmlrpcval($key, 'string'); } if($server->allow_system_funcs) { foreach($GLOBALS['_xmlrpcs_dmap'] as $key => $val) { $outAr[]=new xmlrpcval($key, 'string'); } } return new xmlrpcresp(new xmlrpcval($outAr, 'array')); } $_xmlrpcs_methodSignature_sig=array(array($GLOBALS['xmlrpcArray'], $GLOBALS['xmlrpcString'])); $_xmlrpcs_methodSignature_doc='Returns an array of known signatures (an array of arrays) for the method name passed. If no signatures are known, returns a none-array (test for type != array to detect missing signature)'; $_xmlrpcs_methodSignature_sdoc=array(array('list of known signatures, each sig being an array of xmlrpc type names', 'name of method to be described')); function _xmlrpcs_methodSignature($server, $m) { // let accept as parameter both an xmlrpcval or string if (is_object($m)) { $methName=$m->getParam(0); $methName=$methName->scalarval(); } else { $methName=$m; } if(strpos($methName, "system.") === 0) { $dmap=$GLOBALS['_xmlrpcs_dmap']; $sysCall=1; } else { $dmap=$server->dmap; $sysCall=0; } if(isset($dmap[$methName])) { if(isset($dmap[$methName]['signature'])) { $sigs=array(); foreach($dmap[$methName]['signature'] as $inSig) { $cursig=array(); foreach($inSig as $sig) { $cursig[]=new xmlrpcval($sig, 'string'); } $sigs[]=new xmlrpcval($cursig, 'array'); } $r=new xmlrpcresp(new xmlrpcval($sigs, 'array')); } else { // NB: according to the official docs, we should be returning a // "none-array" here, which means not-an-array $r=new xmlrpcresp(new xmlrpcval('undef', 'string')); } } else { $r=new xmlrpcresp(0,$GLOBALS['xmlrpcerr']['introspect_unknown'], $GLOBALS['xmlrpcstr']['introspect_unknown']); } return $r; } $_xmlrpcs_methodHelp_sig=array(array($GLOBALS['xmlrpcString'], $GLOBALS['xmlrpcString'])); $_xmlrpcs_methodHelp_doc='Returns help text if defined for the method passed, otherwise returns an empty string'; $_xmlrpcs_methodHelp_sdoc=array(array('method description', 'name of the method to be described')); function _xmlrpcs_methodHelp($server, $m) { // let accept as parameter both an xmlrpcval or string if (is_object($m)) { $methName=$m->getParam(0); $methName=$methName->scalarval(); } else { $methName=$m; } if(strpos($methName, "system.") === 0) { $dmap=$GLOBALS['_xmlrpcs_dmap']; $sysCall=1; } else { $dmap=$server->dmap; $sysCall=0; } if(isset($dmap[$methName])) { if(isset($dmap[$methName]['docstring'])) { $r=new xmlrpcresp(new xmlrpcval($dmap[$methName]['docstring']), 'string'); } else { $r=new xmlrpcresp(new xmlrpcval('', 'string')); } } else { $r=new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['introspect_unknown'], $GLOBALS['xmlrpcstr']['introspect_unknown']); } return $r; } $_xmlrpcs_multicall_sig = array(array($GLOBALS['xmlrpcArray'], $GLOBALS['xmlrpcArray'])); $_xmlrpcs_multicall_doc = 'Boxcar multiple RPC calls in one request. See http://www.xmlrpc.com/discuss/msgReader$1208 for details'; $_xmlrpcs_multicall_sdoc = array(array('list of response structs, where each struct has the usual members', 'list of calls, with each call being represented as a struct, with members "methodname" and "params"')); function _xmlrpcs_multicall_error($err) { if(is_string($err)) { $str = $GLOBALS['xmlrpcstr']["multicall_${err}"]; $code = $GLOBALS['xmlrpcerr']["multicall_${err}"]; } else { $code = $err->faultCode(); $str = $err->faultString(); } $struct = array(); $struct['faultCode'] = new xmlrpcval($code, 'int'); $struct['faultString'] = new xmlrpcval($str, 'string'); return new xmlrpcval($struct, 'struct'); } function _xmlrpcs_multicall_do_call($server, $call) { if($call->kindOf() != 'struct') { return _xmlrpcs_multicall_error('notstruct'); } $methName = @$call->structmem('methodName'); if(!$methName) { return _xmlrpcs_multicall_error('nomethod'); } if($methName->kindOf() != 'scalar' || $methName->scalartyp() != 'string') { return _xmlrpcs_multicall_error('notstring'); } if($methName->scalarval() == 'system.multicall') { return _xmlrpcs_multicall_error('recursion'); } $params = @$call->structmem('params'); if(!$params) { return _xmlrpcs_multicall_error('noparams'); } if($params->kindOf() != 'array') { return _xmlrpcs_multicall_error('notarray'); } $numParams = $params->arraysize(); $msg = new xmlrpcmsg($methName->scalarval()); for($i = 0; $i < $numParams; $i++) { if(!$msg->addParam($params->arraymem($i))) { $i++; return _xmlrpcs_multicall_error(new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['incorrect_params'], $GLOBALS['xmlrpcstr']['incorrect_params'] . ": probable xml error in param " . $i)); } } $result = $server->execute($msg); if($result->faultCode() != 0) { return _xmlrpcs_multicall_error($result); // Method returned fault. } return new xmlrpcval(array($result->value()), 'array'); } function _xmlrpcs_multicall_do_call_phpvals($server, $call) { if(!is_array($call)) { return _xmlrpcs_multicall_error('notstruct'); } if(!array_key_exists('methodName', $call)) { return _xmlrpcs_multicall_error('nomethod'); } if (!is_string($call['methodName'])) { return _xmlrpcs_multicall_error('notstring'); } if($call['methodName'] == 'system.multicall') { return _xmlrpcs_multicall_error('recursion'); } if(!array_key_exists('params', $call)) { return _xmlrpcs_multicall_error('noparams'); } if(!is_array($call['params'])) { return _xmlrpcs_multicall_error('notarray'); } // this is a real dirty and simplistic hack, since we might have received a // base64 or datetime values, but they will be listed as strings here... $numParams = count($call['params']); $pt = array(); foreach($call['params'] as $val) $pt[] = php_2_xmlrpc_type(gettype($val)); $result = $server->execute($call['methodName'], $call['params'], $pt); if($result->faultCode() != 0) { return _xmlrpcs_multicall_error($result); // Method returned fault. } return new xmlrpcval(array($result->value()), 'array'); } function _xmlrpcs_multicall($server, $m) { $result = array(); // let accept a plain list of php parameters, beside a single xmlrpc msg object if (is_object($m)) { $calls = $m->getParam(0); $numCalls = $calls->arraysize(); for($i = 0; $i < $numCalls; $i++) { $call = $calls->arraymem($i); $result[$i] = _xmlrpcs_multicall_do_call($server, $call); } } else { $numCalls=count($m); for($i = 0; $i < $numCalls; $i++) { $result[$i] = _xmlrpcs_multicall_do_call_phpvals($server, $m[$i]); } } return new xmlrpcresp(new xmlrpcval($result, 'array')); } $GLOBALS['_xmlrpcs_dmap']=array( 'system.listMethods' => array( 'function' => '_xmlrpcs_listMethods', 'signature' => $_xmlrpcs_listMethods_sig, 'docstring' => $_xmlrpcs_listMethods_doc, 'signature_docs' => $_xmlrpcs_listMethods_sdoc), 'system.methodHelp' => array( 'function' => '_xmlrpcs_methodHelp', 'signature' => $_xmlrpcs_methodHelp_sig, 'docstring' => $_xmlrpcs_methodHelp_doc, 'signature_docs' => $_xmlrpcs_methodHelp_sdoc), 'system.methodSignature' => array( 'function' => '_xmlrpcs_methodSignature', 'signature' => $_xmlrpcs_methodSignature_sig, 'docstring' => $_xmlrpcs_methodSignature_doc, 'signature_docs' => $_xmlrpcs_methodSignature_sdoc), 'system.multicall' => array( 'function' => '_xmlrpcs_multicall', 'signature' => $_xmlrpcs_multicall_sig, 'docstring' => $_xmlrpcs_multicall_doc, 'signature_docs' => $_xmlrpcs_multicall_sdoc), 'system.getCapabilities' => array( 'function' => '_xmlrpcs_getCapabilities', 'signature' => $_xmlrpcs_getCapabilities_sig, 'docstring' => $_xmlrpcs_getCapabilities_doc, 'signature_docs' => $_xmlrpcs_getCapabilities_sdoc) ); $GLOBALS['_xmlrpcs_occurred_errors'] = ''; $GLOBALS['_xmlrpcs_prev_ehandler'] = ''; /** * Error handler used to track errors that occur during server-side execution of PHP code. * This allows to report back to the client whether an internal error has occurred or not * using an xmlrpc response object, instead of letting the client deal with the html junk * that a PHP execution error on the server generally entails. * * NB: in fact a user defined error handler can only handle WARNING, NOTICE and USER_* errors. * */ function _xmlrpcs_errorHandler($errcode, $errstring, $filename=null, $lineno=null, $context=null) { // obey the @ protocol if (error_reporting() == 0) return; //if($errcode != E_NOTICE && $errcode != E_WARNING && $errcode != E_USER_NOTICE && $errcode != E_USER_WARNING) if($errcode != E_STRICT) { $GLOBALS['_xmlrpcs_occurred_errors'] = $GLOBALS['_xmlrpcs_occurred_errors'] . $errstring . "\n"; } // Try to avoid as much as possible disruption to the previous error handling // mechanism in place if($GLOBALS['_xmlrpcs_prev_ehandler'] == '') { // The previous error handler was the default: all we should do is log error // to the default error log (if level high enough) if(ini_get('log_errors') && (intval(ini_get('error_reporting')) & $errcode)) { error_log($errstring); } } else { // Pass control on to previous error handler, trying to avoid loops... if($GLOBALS['_xmlrpcs_prev_ehandler'] != '_xmlrpcs_errorHandler') { // NB: this code will NOT work on php < 4.0.2: only 2 params were used for error handlers if(is_array($GLOBALS['_xmlrpcs_prev_ehandler'])) { // the following works both with static class methods and plain object methods as error handler call_user_func_array($GLOBALS['_xmlrpcs_prev_ehandler'], array($errcode, $errstring, $filename, $lineno, $context)); } else { $GLOBALS['_xmlrpcs_prev_ehandler']($errcode, $errstring, $filename, $lineno, $context); } } } } $GLOBALS['_xmlrpc_debuginfo']=''; /** * Add a string to the debug info that can be later seralized by the server * as part of the response message. * Note that for best compatbility, the debug string should be encoded using * the $GLOBALS['xmlrpc_internalencoding'] character set. * @param string $m * @access public */ function xmlrpc_debugmsg($m) { $GLOBALS['_xmlrpc_debuginfo'] .= $m . "\n"; } class xmlrpc_server { /** * Array defining php functions exposed as xmlrpc methods by this server * @access private */ var $dmap=array(); /** * Defines how functions in dmap will be invoked: either using an xmlrpc msg object * or plain php values. * valid strings are 'xmlrpcvals', 'phpvals' or 'epivals' */ var $functions_parameters_type='xmlrpcvals'; /** * Option used for fine-tuning the encoding the php values returned from * functions registered in the dispatch map when the functions_parameters_types * member is set to 'phpvals' * @see php_xmlrpc_encode for a list of values */ var $phpvals_encoding_options = array( 'auto_dates' ); /// controls wether the server is going to echo debugging messages back to the client as comments in response body. valid values: 0,1,2,3 var $debug = 1; /** * Controls behaviour of server when invoked user function throws an exception: * 0 = catch it and return an 'internal error' xmlrpc response (default) * 1 = catch it and return an xmlrpc response with the error corresponding to the exception * 2 = allow the exception to float to the upper layers */ var $exception_handling = 0; /** * When set to true, it will enable HTTP compression of the response, in case * the client has declared its support for compression in the request. */ var $compress_response = false; /** * List of http compression methods accepted by the server for requests. * NB: PHP supports deflate, gzip compressions out of the box if compiled w. zlib */ var $accepted_compression = array(); /// shall we serve calls to system.* methods? var $allow_system_funcs = true; /// list of charset encodings natively accepted for requests var $accepted_charset_encodings = array(); /** * charset encoding to be used for response. * NB: if we can, we will convert the generated response from internal_encoding to the intended one. * can be: a supported xml encoding (only UTF-8 and ISO-8859-1 at present, unless mbstring is enabled), * null (leave unspecified in response, convert output stream to US_ASCII), * 'default' (use xmlrpc library default as specified in xmlrpc.inc, convert output stream if needed), * or 'auto' (use client-specified charset encoding or same as request if request headers do not specify it (unless request is US-ASCII: then use library default anyway). * NB: pretty dangerous if you accept every charset and do not have mbstring enabled) */ var $response_charset_encoding = ''; /** * Storage for internal debug info * @access private */ var $debug_info = ''; /** * Extra data passed at runtime to method handling functions. Used only by EPI layer */ var $user_data = null; /** * @param array $dispmap the dispatch map withd efinition of exposed services * @param boolean $servicenow set to false to prevent the server from runnung upon construction */ function xmlrpc_server($dispMap=null, $serviceNow=true) { // if ZLIB is enabled, let the server by default accept compressed requests, // and compress responses sent to clients that support them if(function_exists('gzinflate')) { $this->accepted_compression = array('gzip', 'deflate'); $this->compress_response = true; } // by default the xml parser can support these 3 charset encodings $this->accepted_charset_encodings = array('UTF-8', 'ISO-8859-1', 'US-ASCII'); // dispMap is a dispatch array of methods // mapped to function names and signatures // if a method // doesn't appear in the map then an unknown // method error is generated /* milosch - changed to make passing dispMap optional. * instead, you can use the class add_to_map() function * to add functions manually (borrowed from SOAPX4) */ if($dispMap) { $this->dmap = $dispMap; if($serviceNow) { $this->service(); } } } /** * Set debug level of server. * @param integer $in debug lvl: determines info added to xmlrpc responses (as xml comments) * 0 = no debug info, * 1 = msgs set from user with debugmsg(), * 2 = add complete xmlrpc request (headers and body), * 3 = add also all processing warnings happened during method processing * (NB: this involves setting a custom error handler, and might interfere * with the standard processing of the php function exposed as method. In * particular, triggering an USER_ERROR level error will not halt script * execution anymore, but just end up logged in the xmlrpc response) * Note that info added at elevel 2 and 3 will be base64 encoded * @access public */ function setDebug($in) { $this->debug=$in; } /** * Return a string with the serialized representation of all debug info * @param string $charset_encoding the target charset encoding for the serialization * @return string an XML comment (or two) */ function serializeDebug($charset_encoding='') { // Tough encoding problem: which internal charset should we assume for debug info? // It might contain a copy of raw data received from client, ie with unknown encoding, // intermixed with php generated data and user generated data... // so we split it: system debug is base 64 encoded, // user debug info should be encoded by the end user using the INTERNAL_ENCODING $out = ''; if ($this->debug_info != '') { $out .= "\n"; } if($GLOBALS['_xmlrpc_debuginfo']!='') { $out .= "\n"; // NB: a better solution MIGHT be to use CDATA, but we need to insert it // into return payload AFTER the beginning tag //$out .= "', ']_]_>', $GLOBALS['_xmlrpc_debuginfo']) . "\n]]>\n"; } return $out; } /** * Execute the xmlrpc request, printing the response * @param string $data the request body. If null, the http POST request will be examined * @return xmlrpcresp the response object (usually not used by caller...) * @access public */ function service($data=null, $return_payload=false) { if ($data === null) { // workaround for a known bug in php ver. 5.2.2 that broke $HTTP_RAW_POST_DATA $ver = phpversion(); if ($ver[0] >= 5) { $data = file_get_contents('php://input'); } else { $data = isset($GLOBALS['HTTP_RAW_POST_DATA']) ? $GLOBALS['HTTP_RAW_POST_DATA'] : ''; } } $raw_data = $data; // reset internal debug info $this->debug_info = ''; // Echo back what we received, before parsing it if($this->debug > 1) { $this->debugmsg("+++GOT+++\n" . $data . "\n+++END+++"); } $r = $this->parseRequestHeaders($data, $req_charset, $resp_charset, $resp_encoding); if (!$r) { $r=$this->parseRequest($data, $req_charset); } // save full body of request into response, for more debugging usages $r->raw_data = $raw_data; if($this->debug > 2 && $GLOBALS['_xmlrpcs_occurred_errors']) { $this->debugmsg("+++PROCESSING ERRORS AND WARNINGS+++\n" . $GLOBALS['_xmlrpcs_occurred_errors'] . "+++END+++"); } $payload=$this->xml_header($resp_charset); if($this->debug > 0) { $payload = $payload . $this->serializeDebug($resp_charset); } // G. Giunta 2006-01-27: do not create response serialization if it has // already happened. Helps building json magic if (empty($r->payload)) { $r->serialize($resp_charset); } $payload = $payload . $r->payload; if ($return_payload) { return $payload; } // if we get a warning/error that has output some text before here, then we cannot // add a new header. We cannot say we are sending xml, either... if(!headers_sent()) { header('Content-Type: '.$r->content_type); // we do not know if client actually told us an accepted charset, but if he did // we have to tell him what we did header("Vary: Accept-Charset"); // http compression of output: only // if we can do it, and we want to do it, and client asked us to, // and php ini settings do not force it already $php_no_self_compress = !ini_get('zlib.output_compression') && (ini_get('output_handler') != 'ob_gzhandler'); if($this->compress_response && function_exists('gzencode') && $resp_encoding != '' && $php_no_self_compress) { if(strpos($resp_encoding, 'gzip') !== false) { $payload = gzencode($payload); header("Content-Encoding: gzip"); header("Vary: Accept-Encoding"); } elseif (strpos($resp_encoding, 'deflate') !== false) { $payload = gzcompress($payload); header("Content-Encoding: deflate"); header("Vary: Accept-Encoding"); } } // do not ouput content-length header if php is compressing output for us: // it will mess up measurements if($php_no_self_compress) { header('Content-Length: ' . (int)strlen($payload)); } } else { error_log('XML-RPC: '.__METHOD__.': http headers already sent before response is fully generated. Check for php warning or error messages'); } print $payload; // return request, in case subclasses want it return $r; } /** * Add a method to the dispatch map * @param string $methodname the name with which the method will be made available * @param string $function the php function that will get invoked * @param array $sig the array of valid method signatures * @param string $doc method documentation * @param array $sigdoc the array of valid method signatures docs (one string per param, one for return type) * @access public */ function add_to_map($methodname,$function,$sig=null,$doc=false,$sigdoc=false) { $this->dmap[$methodname] = array( 'function' => $function, 'docstring' => $doc ); if ($sig) { $this->dmap[$methodname]['signature'] = $sig; } if ($sigdoc) { $this->dmap[$methodname]['signature_docs'] = $sigdoc; } } /** * Verify type and number of parameters received against a list of known signatures * @param array $in array of either xmlrpcval objects or xmlrpc type definitions * @param array $sig array of known signatures to match against * @access private */ function verifySignature($in, $sig) { // check each possible signature in turn if (is_object($in)) { $numParams = $in->getNumParams(); } else { $numParams = count($in); } foreach($sig as $cursig) { if(count($cursig)==$numParams+1) { $itsOK=1; for($n=0; $n<$numParams; $n++) { if (is_object($in)) { $p=$in->getParam($n); if($p->kindOf() == 'scalar') { $pt=$p->scalartyp(); } else { $pt=$p->kindOf(); } } else { $pt= $in[$n] == 'i4' ? 'int' : strtolower($in[$n]); // dispatch maps never use i4... } // param index is $n+1, as first member of sig is return type if($pt != $cursig[$n+1] && $cursig[$n+1] != $GLOBALS['xmlrpcValue']) { $itsOK=0; $pno=$n+1; $wanted=$cursig[$n+1]; $got=$pt; break; } } if($itsOK) { return array(1,''); } } } if(isset($wanted)) { return array(0, "Wanted ${wanted}, got ${got} at param ${pno}"); } else { return array(0, "No method signature matches number of parameters"); } } /** * Parse http headers received along with xmlrpc request. If needed, inflate request * @return null on success or an xmlrpcresp * @access private */ function parseRequestHeaders(&$data, &$req_encoding, &$resp_encoding, &$resp_compression) { // check if $_SERVER is populated: it might have been disabled via ini file // (this is true even when in CLI mode) if (count($_SERVER) == 0) { error_log('XML-RPC: '.__METHOD__.': cannot parse request headers as $_SERVER is not populated'); } if($this->debug > 1) { if(function_exists('getallheaders')) { $this->debugmsg(''); // empty line foreach(getallheaders() as $name => $val) { $this->debugmsg("HEADER: $name: $val"); } } } if(isset($_SERVER['HTTP_CONTENT_ENCODING'])) { $content_encoding = str_replace('x-', '', $_SERVER['HTTP_CONTENT_ENCODING']); } else { $content_encoding = ''; } // check if request body has been compressed and decompress it if($content_encoding != '' && strlen($data)) { if($content_encoding == 'deflate' || $content_encoding == 'gzip') { // if decoding works, use it. else assume data wasn't gzencoded if(function_exists('gzinflate') && in_array($content_encoding, $this->accepted_compression)) { if($content_encoding == 'deflate' && $degzdata = @gzuncompress($data)) { $data = $degzdata; if($this->debug > 1) { $this->debugmsg("\n+++INFLATED REQUEST+++[".strlen($data)." chars]+++\n" . $data . "\n+++END+++"); } } elseif($content_encoding == 'gzip' && $degzdata = @gzinflate(substr($data, 10))) { $data = $degzdata; if($this->debug > 1) $this->debugmsg("+++INFLATED REQUEST+++[".strlen($data)." chars]+++\n" . $data . "\n+++END+++"); } else { $r = new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['server_decompress_fail'], $GLOBALS['xmlrpcstr']['server_decompress_fail']); return $r; } } else { //error_log('The server sent deflated data. Your php install must have the Zlib extension compiled in to support this.'); $r = new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['server_cannot_decompress'], $GLOBALS['xmlrpcstr']['server_cannot_decompress']); return $r; } } } // check if client specified accepted charsets, and if we know how to fulfill // the request if ($this->response_charset_encoding == 'auto') { $resp_encoding = ''; if (isset($_SERVER['HTTP_ACCEPT_CHARSET'])) { // here we should check if we can match the client-requested encoding // with the encodings we know we can generate. /// @todo we should parse q=0.x preferences instead of getting first charset specified... $client_accepted_charsets = explode(',', strtoupper($_SERVER['HTTP_ACCEPT_CHARSET'])); // Give preference to internal encoding $known_charsets = array($GLOBALS['xmlrpc_internalencoding'], 'UTF-8', 'ISO-8859-1', 'US-ASCII'); foreach ($known_charsets as $charset) { foreach ($client_accepted_charsets as $accepted) if (strpos($accepted, $charset) === 0) { $resp_encoding = $charset; break; } if ($resp_encoding) break; } } } else { $resp_encoding = $this->response_charset_encoding; } if (isset($_SERVER['HTTP_ACCEPT_ENCODING'])) { $resp_compression = $_SERVER['HTTP_ACCEPT_ENCODING']; } else { $resp_compression = ''; } // 'guestimate' request encoding /// @todo check if mbstring is enabled and automagic input conversion is on: it might mingle with this check??? $req_encoding = guess_encoding(isset($_SERVER['CONTENT_TYPE']) ? $_SERVER['CONTENT_TYPE'] : '', $data); return null; } /** * Parse an xml chunk containing an xmlrpc request and execute the corresponding * php function registered with the server * @param string $data the xml request * @param string $req_encoding (optional) the charset encoding of the xml request * @return xmlrpcresp * @access private */ function parseRequest($data, $req_encoding='') { // 2005/05/07 commented and moved into caller function code //if($data=='') //{ // $data=$GLOBALS['HTTP_RAW_POST_DATA']; //} // G. Giunta 2005/02/13: we do NOT expect to receive html entities // so we do not try to convert them into xml character entities //$data = xmlrpc_html_entity_xlate($data); $GLOBALS['_xh']=array(); $GLOBALS['_xh']['ac']=''; $GLOBALS['_xh']['stack']=array(); $GLOBALS['_xh']['valuestack'] = array(); $GLOBALS['_xh']['params']=array(); $GLOBALS['_xh']['pt']=array(); $GLOBALS['_xh']['isf']=0; $GLOBALS['_xh']['isf_reason']=''; $GLOBALS['_xh']['method']=false; // so we can check later if we got a methodname or not $GLOBALS['_xh']['rt']=''; // decompose incoming XML into request structure if ($req_encoding != '') { if (!in_array($req_encoding, array('UTF-8', 'ISO-8859-1', 'US-ASCII'))) // the following code might be better for mb_string enabled installs, but // makes the lib about 200% slower... //if (!is_valid_charset($req_encoding, array('UTF-8', 'ISO-8859-1', 'US-ASCII'))) { error_log('XML-RPC: '.__METHOD__.': invalid charset encoding of received request: '.$req_encoding); $req_encoding = $GLOBALS['xmlrpc_defencoding']; } /// @BUG this will fail on PHP 5 if charset is not specified in the xml prologue, // the encoding is not UTF8 and there are non-ascii chars in the text... /// @todo use an ampty string for php 5 ??? $parser = xml_parser_create($req_encoding); } else { $parser = xml_parser_create(); } xml_parser_set_option($parser, XML_OPTION_CASE_FOLDING, true); // G. Giunta 2005/02/13: PHP internally uses ISO-8859-1, so we have to tell // the xml parser to give us back data in the expected charset // What if internal encoding is not in one of the 3 allowed? // we use the broadest one, ie. utf8 // This allows to send data which is native in various charset, // by extending xmlrpc_encode_entitites() and setting xmlrpc_internalencoding if (!in_array($GLOBALS['xmlrpc_internalencoding'], array('UTF-8', 'ISO-8859-1', 'US-ASCII'))) { xml_parser_set_option($parser, XML_OPTION_TARGET_ENCODING, 'UTF-8'); } else { xml_parser_set_option($parser, XML_OPTION_TARGET_ENCODING, $GLOBALS['xmlrpc_internalencoding']); } if ($this->functions_parameters_type != 'xmlrpcvals') xml_set_element_handler($parser, 'xmlrpc_se', 'xmlrpc_ee_fast'); else xml_set_element_handler($parser, 'xmlrpc_se', 'xmlrpc_ee'); xml_set_character_data_handler($parser, 'xmlrpc_cd'); xml_set_default_handler($parser, 'xmlrpc_dh'); if(!xml_parse($parser, $data, 1)) { // return XML error as a faultCode $r=new xmlrpcresp(0, $GLOBALS['xmlrpcerrxml']+xml_get_error_code($parser), sprintf('XML error: %s at line %d, column %d', xml_error_string(xml_get_error_code($parser)), xml_get_current_line_number($parser), xml_get_current_column_number($parser))); xml_parser_free($parser); } elseif ($GLOBALS['_xh']['isf']) { xml_parser_free($parser); $r=new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['invalid_request'], $GLOBALS['xmlrpcstr']['invalid_request'] . ' ' . $GLOBALS['_xh']['isf_reason']); } else { xml_parser_free($parser); // small layering violation in favor of speed and memory usage: // we should allow the 'execute' method handle this, but in the // most common scenario (xmlrpcvals type server with some methods // registered as phpvals) that would mean a useless encode+decode pass if ($this->functions_parameters_type != 'xmlrpcvals' || (isset($this->dmap[$GLOBALS['_xh']['method']]['parameters_type']) && ($this->dmap[$GLOBALS['_xh']['method']]['parameters_type'] == 'phpvals'))) { if($this->debug > 1) { $this->debugmsg("\n+++PARSED+++\n".var_export($GLOBALS['_xh']['params'], true)."\n+++END+++"); } $r = $this->execute($GLOBALS['_xh']['method'], $GLOBALS['_xh']['params'], $GLOBALS['_xh']['pt']); } else { // build an xmlrpcmsg object with data parsed from xml $m=new xmlrpcmsg($GLOBALS['_xh']['method']); // now add parameters in for($i=0; $iaddParam($GLOBALS['_xh']['params'][$i]); } if($this->debug > 1) { $this->debugmsg("\n+++PARSED+++\n".var_export($m, true)."\n+++END+++"); } $r = $this->execute($m); } } return $r; } /** * Execute a method invoked by the client, checking parameters used * @param mixed $m either an xmlrpcmsg obj or a method name * @param array $params array with method parameters as php types (if m is method name only) * @param array $paramtypes array with xmlrpc types of method parameters (if m is method name only) * @return xmlrpcresp * @access private */ function execute($m, $params=null, $paramtypes=null) { if (is_object($m)) { $methName = $m->method(); } else { $methName = $m; } $sysCall = $this->allow_system_funcs && (strpos($methName, "system.") === 0); $dmap = $sysCall ? $GLOBALS['_xmlrpcs_dmap'] : $this->dmap; if(!isset($dmap[$methName]['function'])) { // No such method return new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['unknown_method'], $GLOBALS['xmlrpcstr']['unknown_method']); } // Check signature if(isset($dmap[$methName]['signature'])) { $sig = $dmap[$methName]['signature']; if (is_object($m)) { list($ok, $errstr) = $this->verifySignature($m, $sig); } else { list($ok, $errstr) = $this->verifySignature($paramtypes, $sig); } if(!$ok) { // Didn't match. return new xmlrpcresp( 0, $GLOBALS['xmlrpcerr']['incorrect_params'], $GLOBALS['xmlrpcstr']['incorrect_params'] . ": ${errstr}" ); } } $func = $dmap[$methName]['function']; // let the 'class::function' syntax be accepted in dispatch maps if(is_string($func) && strpos($func, '::')) { $func = explode('::', $func); } // verify that function to be invoked is in fact callable if(!is_callable($func)) { error_log("XML-RPC: ".__METHOD__.": function $func registered as method handler is not callable"); return new xmlrpcresp( 0, $GLOBALS['xmlrpcerr']['server_error'], $GLOBALS['xmlrpcstr']['server_error'] . ": no function matches method" ); } // If debug level is 3, we should catch all errors generated during // processing of user function, and log them as part of response if($this->debug > 2) { $GLOBALS['_xmlrpcs_prev_ehandler'] = set_error_handler('_xmlrpcs_errorHandler'); } try { // Allow mixed-convention servers if (is_object($m)) { if($sysCall) { $r = call_user_func($func, $this, $m); } else { $r = call_user_func($func, $m); } if (!is_a($r, 'xmlrpcresp')) { error_log("XML-RPC: ".__METHOD__.": function $func registered as method handler does not return an xmlrpcresp object"); if (is_a($r, 'xmlrpcval')) { $r = new xmlrpcresp($r); } else { $r = new xmlrpcresp( 0, $GLOBALS['xmlrpcerr']['server_error'], $GLOBALS['xmlrpcstr']['server_error'] . ": function does not return xmlrpcresp object" ); } } } else { // call a 'plain php' function if($sysCall) { array_unshift($params, $this); $r = call_user_func_array($func, $params); } else { // 3rd API convention for method-handling functions: EPI-style if ($this->functions_parameters_type == 'epivals') { $r = call_user_func_array($func, array($methName, $params, $this->user_data)); // mimic EPI behaviour: if we get an array that looks like an error, make it // an eror response if (is_array($r) && array_key_exists('faultCode', $r) && array_key_exists('faultString', $r)) { $r = new xmlrpcresp(0, (integer)$r['faultCode'], (string)$r['faultString']); } else { // functions using EPI api should NOT return resp objects, // so make sure we encode the return type correctly $r = new xmlrpcresp(php_xmlrpc_encode($r, array('extension_api'))); } } else { $r = call_user_func_array($func, $params); } } // the return type can be either an xmlrpcresp object or a plain php value... if (!is_a($r, 'xmlrpcresp')) { // what should we assume here about automatic encoding of datetimes // and php classes instances??? $r = new xmlrpcresp(php_xmlrpc_encode($r, $this->phpvals_encoding_options)); } } } catch(Exception $e) { // (barring errors in the lib) an uncatched exception happened // in the called function, we wrap it in a proper error-response switch($this->exception_handling) { case 2: throw $e; break; case 1: $r = new xmlrpcresp(0, $e->getCode(), $e->getMessage()); break; default: $r = new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['server_error'], $GLOBALS['xmlrpcstr']['server_error']); } } if($this->debug > 2) { // note: restore the error handler we found before calling the // user func, even if it has been changed inside the func itself if($GLOBALS['_xmlrpcs_prev_ehandler']) { set_error_handler($GLOBALS['_xmlrpcs_prev_ehandler']); } else { restore_error_handler(); } } return $r; } /** * add a string to the 'internal debug message' (separate from 'user debug message') * @param string $strings * @access private */ function debugmsg($string) { $this->debug_info .= $string."\n"; } /** * @access private */ function xml_header($charset_encoding='') { if ($charset_encoding != '') { return "\n"; } else { return "\n"; } } /** * A debugging routine: just echoes back the input packet as a string value * DEPRECATED! */ function echoInput() { $r=new xmlrpcresp(new xmlrpcval( "'Aha said I: '" . $GLOBALS['HTTP_RAW_POST_DATA'], 'string')); print $r->serialize(); } } ?>transport/xmlrpc-3.0.0.beta/lib/index.html000066600000000037151375520470014233 0ustar00 transport/xmlrpc-3.0.0.beta/lib/xmlrpc.inc000066600000337502151375520470014250 0ustar00 // $Id: xmlrpc.inc,v 1.174 2009/03/16 19:36:38 ggiunta Exp $ // Copyright (c) 1999,2000,2002 Edd Dumbill. // All rights reserved. // // Redistribution and use in source and binary forms, with or without // modification, are permitted provided that the following conditions // are met: // // * Redistributions of source code must retain the above copyright // notice, this list of conditions and the following disclaimer. // // * Redistributions in binary form must reproduce the above // copyright notice, this list of conditions and the following // disclaimer in the documentation and/or other materials provided // with the distribution. // // * Neither the name of the "XML-RPC for PHP" nor the names of its // contributors may be used to endorse or promote products derived // from this software without specific prior written permission. // // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS // FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE // REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, // INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES // (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR // SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) // HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, // STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) // ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED // OF THE POSSIBILITY OF SUCH DAMAGE. if(!function_exists('xml_parser_create')) { // For PHP 4 onward, XML functionality is always compiled-in on windows: // no more need to dl-open it. It might have been compiled out on *nix... if(strtoupper(substr(PHP_OS, 0, 3) != 'WIN')) { dl('xml.so'); } } // G. Giunta 2005/01/29: declare global these variables, // so that xmlrpc.inc will work even if included from within a function // Milosch: 2005/08/07 - explicitly request these via $GLOBALS where used. $GLOBALS['xmlrpcI4']='i4'; $GLOBALS['xmlrpcInt']='int'; $GLOBALS['xmlrpcBoolean']='boolean'; $GLOBALS['xmlrpcDouble']='double'; $GLOBALS['xmlrpcString']='string'; $GLOBALS['xmlrpcDateTime']='dateTime.iso8601'; $GLOBALS['xmlrpcBase64']='base64'; $GLOBALS['xmlrpcArray']='array'; $GLOBALS['xmlrpcStruct']='struct'; $GLOBALS['xmlrpcValue']='undefined'; $GLOBALS['xmlrpcTypes']=array( $GLOBALS['xmlrpcI4'] => 1, $GLOBALS['xmlrpcInt'] => 1, $GLOBALS['xmlrpcBoolean'] => 1, $GLOBALS['xmlrpcString'] => 1, $GLOBALS['xmlrpcDouble'] => 1, $GLOBALS['xmlrpcDateTime'] => 1, $GLOBALS['xmlrpcBase64'] => 1, $GLOBALS['xmlrpcArray'] => 2, $GLOBALS['xmlrpcStruct'] => 3 ); $GLOBALS['xmlrpc_valid_parents'] = array( 'VALUE' => array('MEMBER', 'DATA', 'PARAM', 'FAULT'), 'BOOLEAN' => array('VALUE'), 'I4' => array('VALUE'), 'INT' => array('VALUE'), 'STRING' => array('VALUE'), 'DOUBLE' => array('VALUE'), 'DATETIME.ISO8601' => array('VALUE'), 'BASE64' => array('VALUE'), 'MEMBER' => array('STRUCT'), 'NAME' => array('MEMBER'), 'DATA' => array('ARRAY'), 'ARRAY' => array('VALUE'), 'STRUCT' => array('VALUE'), 'PARAM' => array('PARAMS'), 'METHODNAME' => array('METHODCALL'), 'PARAMS' => array('METHODCALL', 'METHODRESPONSE'), 'FAULT' => array('METHODRESPONSE'), 'NIL' => array('VALUE'), // only used when extension activated 'EX:NIL' => array('VALUE') // only used when extension activated ); // define extra types for supporting NULL (useful for json or ) $GLOBALS['xmlrpcNull']='null'; $GLOBALS['xmlrpcTypes']['null']=1; // Not in use anymore since 2.0. Shall we remove it? /// @deprecated $GLOBALS['xmlEntities']=array( 'amp' => '&', 'quot' => '"', 'lt' => '<', 'gt' => '>', 'apos' => "'" ); // tables used for transcoding different charsets into us-ascii xml $GLOBALS['xml_iso88591_Entities']=array(); $GLOBALS['xml_iso88591_Entities']['in'] = array(); $GLOBALS['xml_iso88591_Entities']['out'] = array(); for ($i = 0; $i < 32; $i++) { $GLOBALS['xml_iso88591_Entities']['in'][] = chr($i); $GLOBALS['xml_iso88591_Entities']['out'][] = '&#'.$i.';'; } for ($i = 160; $i < 256; $i++) { $GLOBALS['xml_iso88591_Entities']['in'][] = chr($i); $GLOBALS['xml_iso88591_Entities']['out'][] = '&#'.$i.';'; } /// @todo add to iso table the characters from cp_1252 range, i.e. 128 to 159? /// These will NOT be present in true ISO-8859-1, but will save the unwary /// windows user from sending junk (though no luck when reciving them...) /* $GLOBALS['xml_cp1252_Entities']=array(); for ($i = 128; $i < 160; $i++) { $GLOBALS['xml_cp1252_Entities']['in'][] = chr($i); } $GLOBALS['xml_cp1252_Entities']['out'] = array( '€', '?', '‚', 'ƒ', '„', '…', '†', '‡', 'ˆ', '‰', 'Š', '‹', 'Œ', '?', 'Ž', '?', '?', '‘', '’', '“', '”', '•', '–', '—', '˜', '™', 'š', '›', 'œ', '?', 'ž', 'Ÿ' ); */ $GLOBALS['xmlrpcerr'] = array( 'unknown_method'=>1, 'invalid_return'=>2, 'incorrect_params'=>3, 'introspect_unknown'=>4, 'http_error'=>5, 'no_data'=>6, 'no_ssl'=>7, 'curl_fail'=>8, 'invalid_request'=>15, 'no_curl'=>16, 'server_error'=>17, 'multicall_error'=>18, 'multicall_notstruct'=>9, 'multicall_nomethod'=>10, 'multicall_notstring'=>11, 'multicall_recursion'=>12, 'multicall_noparams'=>13, 'multicall_notarray'=>14, 'cannot_decompress'=>103, 'decompress_fail'=>104, 'dechunk_fail'=>105, 'server_cannot_decompress'=>106, 'server_decompress_fail'=>107 ); $GLOBALS['xmlrpcstr'] = array( 'unknown_method'=>'Unknown method', 'invalid_return'=>'Invalid return payload: enable debugging to examine incoming payload', 'incorrect_params'=>'Incorrect parameters passed to method', 'introspect_unknown'=>"Can't introspect: method unknown", 'http_error'=>"Didn't receive 200 OK from remote server.", 'no_data'=>'No data received from server.', 'no_ssl'=>'No SSL support compiled in.', 'curl_fail'=>'CURL error', 'invalid_request'=>'Invalid request payload', 'no_curl'=>'No CURL support compiled in.', 'server_error'=>'Internal server error', 'multicall_error'=>'Received from server invalid multicall response', 'multicall_notstruct'=>'system.multicall expected struct', 'multicall_nomethod'=>'missing methodName', 'multicall_notstring'=>'methodName is not a string', 'multicall_recursion'=>'recursive system.multicall forbidden', 'multicall_noparams'=>'missing params', 'multicall_notarray'=>'params is not an array', 'cannot_decompress'=>'Received from server compressed HTTP and cannot decompress', 'decompress_fail'=>'Received from server invalid compressed HTTP', 'dechunk_fail'=>'Received from server invalid chunked HTTP', 'server_cannot_decompress'=>'Received from client compressed HTTP request and cannot decompress', 'server_decompress_fail'=>'Received from client invalid compressed HTTP request' ); // The charset encoding used by the server for received messages and // by the client for received responses when received charset cannot be determined // or is not supported $GLOBALS['xmlrpc_defencoding']='UTF-8'; // The encoding used internally by PHP. // String values received as xml will be converted to this, and php strings will be converted to xml // as if having been coded with this $GLOBALS['xmlrpc_internalencoding']='ISO-8859-1'; $GLOBALS['xmlrpcName']='XML-RPC for PHP'; $GLOBALS['xmlrpcVersion']='3.0.0.beta'; // let user errors start at 800 $GLOBALS['xmlrpcerruser']=800; // let XML parse errors start at 100 $GLOBALS['xmlrpcerrxml']=100; // formulate backslashes for escaping regexp // Not in use anymore since 2.0. Shall we remove it? /// @deprecated $GLOBALS['xmlrpc_backslash']=chr(92).chr(92); // set to TRUE to enable correct decoding of and values $GLOBALS['xmlrpc_null_extension']=false; // set to TRUE to enable encoding of php NULL values to instead of $GLOBALS['xmlrpc_null_apache_encoding']=false; // used to store state during parsing // quick explanation of components: // ac - used to accumulate values // isf - used to indicate a parsing fault (2) or xmlrpcresp fault (1) // isf_reason - used for storing xmlrpcresp fault string // lv - used to indicate "looking for a value": implements // the logic to allow values with no types to be strings // params - used to store parameters in method calls // method - used to store method name // stack - array with genealogy of xml elements names: // used to validate nesting of xmlrpc elements $GLOBALS['_xh']=null; /** * Convert a string to the correct XML representation in a target charset * To help correct communication of non-ascii chars inside strings, regardless * of the charset used when sending requests, parsing them, sending responses * and parsing responses, an option is to convert all non-ascii chars present in the message * into their equivalent 'charset entity'. Charset entities enumerated this way * are independent of the charset encoding used to transmit them, and all XML * parsers are bound to understand them. * Note that in the std case we are not sending a charset encoding mime type * along with http headers, so we are bound by RFC 3023 to emit strict us-ascii. * * @todo do a bit of basic benchmarking (strtr vs. str_replace) * @todo make usage of iconv() or recode_string() or mb_string() where available */ function xmlrpc_encode_entitites($data, $src_encoding='', $dest_encoding='') { if ($src_encoding == '') { // lame, but we know no better... $src_encoding = $GLOBALS['xmlrpc_internalencoding']; } switch(strtoupper($src_encoding.'_'.$dest_encoding)) { case 'ISO-8859-1_': case 'ISO-8859-1_US-ASCII': $escaped_data = str_replace(array('&', '"', "'", '<', '>'), array('&', '"', ''', '<', '>'), $data); $escaped_data = str_replace($GLOBALS['xml_iso88591_Entities']['in'], $GLOBALS['xml_iso88591_Entities']['out'], $escaped_data); break; case 'ISO-8859-1_UTF-8': $escaped_data = str_replace(array('&', '"', "'", '<', '>'), array('&', '"', ''', '<', '>'), $data); $escaped_data = utf8_encode($escaped_data); break; case 'ISO-8859-1_ISO-8859-1': case 'US-ASCII_US-ASCII': case 'US-ASCII_UTF-8': case 'US-ASCII_': case 'US-ASCII_ISO-8859-1': case 'UTF-8_UTF-8': //case 'CP1252_CP1252': $escaped_data = str_replace(array('&', '"', "'", '<', '>'), array('&', '"', ''', '<', '>'), $data); break; case 'UTF-8_': case 'UTF-8_US-ASCII': case 'UTF-8_ISO-8859-1': // NB: this will choke on invalid UTF-8, going most likely beyond EOF $escaped_data = ''; // be kind to users creating string xmlrpcvals out of different php types $data = (string) $data; $ns = strlen ($data); for ($nn = 0; $nn < $ns; $nn++) { $ch = $data[$nn]; $ii = ord($ch); //1 7 0bbbbbbb (127) if ($ii < 128) { /// @todo shall we replace this with a (supposedly) faster str_replace? switch($ii){ case 34: $escaped_data .= '"'; break; case 38: $escaped_data .= '&'; break; case 39: $escaped_data .= '''; break; case 60: $escaped_data .= '<'; break; case 62: $escaped_data .= '>'; break; default: $escaped_data .= $ch; } // switch } //2 11 110bbbbb 10bbbbbb (2047) else if ($ii>>5 == 6) { $b1 = ($ii & 31); $ii = ord($data[$nn+1]); $b2 = ($ii & 63); $ii = ($b1 * 64) + $b2; $ent = sprintf ('&#%d;', $ii); $escaped_data .= $ent; $nn += 1; } //3 16 1110bbbb 10bbbbbb 10bbbbbb else if ($ii>>4 == 14) { $b1 = ($ii & 15); $ii = ord($data[$nn+1]); $b2 = ($ii & 63); $ii = ord($data[$nn+2]); $b3 = ($ii & 63); $ii = ((($b1 * 64) + $b2) * 64) + $b3; $ent = sprintf ('&#%d;', $ii); $escaped_data .= $ent; $nn += 2; } //4 21 11110bbb 10bbbbbb 10bbbbbb 10bbbbbb else if ($ii>>3 == 30) { $b1 = ($ii & 7); $ii = ord($data[$nn+1]); $b2 = ($ii & 63); $ii = ord($data[$nn+2]); $b3 = ($ii & 63); $ii = ord($data[$nn+3]); $b4 = ($ii & 63); $ii = ((((($b1 * 64) + $b2) * 64) + $b3) * 64) + $b4; $ent = sprintf ('&#%d;', $ii); $escaped_data .= $ent; $nn += 3; } } break; /* case 'CP1252_': case 'CP1252_US-ASCII': $escaped_data = str_replace(array('&', '"', "'", '<', '>'), array('&', '"', ''', '<', '>'), $data); $escaped_data = str_replace($GLOBALS['xml_iso88591_Entities']['in'], $GLOBALS['xml_iso88591_Entities']['out'], $escaped_data); $escaped_data = str_replace($GLOBALS['xml_cp1252_Entities']['in'], $GLOBALS['xml_cp1252_Entities']['out'], $escaped_data); break; case 'CP1252_UTF-8': $escaped_data = str_replace(array('&', '"', "'", '<', '>'), array('&', '"', ''', '<', '>'), $data); /// @todo we could use real UTF8 chars here instead of xml entities... (note that utf_8 encode all allone will NOT convert them) $escaped_data = str_replace($GLOBALS['xml_cp1252_Entities']['in'], $GLOBALS['xml_cp1252_Entities']['out'], $escaped_data); $escaped_data = utf8_encode($escaped_data); break; case 'CP1252_ISO-8859-1': $escaped_data = str_replace(array('&', '"', "'", '<', '>'), array('&', '"', ''', '<', '>'), $data); // we might as well replave all funky chars with a '?' here, but we are kind and leave it to the receiving application layer to decide what to do with these weird entities... $escaped_data = str_replace($GLOBALS['xml_cp1252_Entities']['in'], $GLOBALS['xml_cp1252_Entities']['out'], $escaped_data); break; */ default: $escaped_data = ''; error_log("Converting from $src_encoding to $dest_encoding: not supported..."); } return $escaped_data; } /// xml parser handler function for opening element tags function xmlrpc_se($parser, $name, $attrs, $accept_single_vals=false) { // if invalid xmlrpc already detected, skip all processing if ($GLOBALS['_xh']['isf'] < 2) { // check for correct element nesting // top level element can only be of 2 types /// @todo optimization creep: save this check into a bool variable, instead of using count() every time: /// there is only a single top level element in xml anyway if (count($GLOBALS['_xh']['stack']) == 0) { if ($name != 'METHODRESPONSE' && $name != 'METHODCALL' && ( $name != 'VALUE' && !$accept_single_vals)) { $GLOBALS['_xh']['isf'] = 2; $GLOBALS['_xh']['isf_reason'] = 'missing top level xmlrpc element'; return; } else { $GLOBALS['_xh']['rt'] = strtolower($name); $GLOBALS['_xh']['rt'] = strtolower($name); } } else { // not top level element: see if parent is OK $parent = end($GLOBALS['_xh']['stack']); if (!array_key_exists($name, $GLOBALS['xmlrpc_valid_parents']) || !in_array($parent, $GLOBALS['xmlrpc_valid_parents'][$name])) { $GLOBALS['_xh']['isf'] = 2; $GLOBALS['_xh']['isf_reason'] = "xmlrpc element $name cannot be child of $parent"; return; } } switch($name) { // optimize for speed switch cases: most common cases first case 'VALUE': /// @todo we could check for 2 VALUE elements inside a MEMBER or PARAM element $GLOBALS['_xh']['vt']='value'; // indicator: no value found yet $GLOBALS['_xh']['ac']=''; $GLOBALS['_xh']['lv']=1; $GLOBALS['_xh']['php_class']=null; break; case 'I4': case 'INT': case 'STRING': case 'BOOLEAN': case 'DOUBLE': case 'DATETIME.ISO8601': case 'BASE64': if ($GLOBALS['_xh']['vt']!='value') { //two data elements inside a value: an error occurred! $GLOBALS['_xh']['isf'] = 2; $GLOBALS['_xh']['isf_reason'] = "$name element following a {$GLOBALS['_xh']['vt']} element inside a single value"; return; } $GLOBALS['_xh']['ac']=''; // reset the accumulator break; case 'STRUCT': case 'ARRAY': if ($GLOBALS['_xh']['vt']!='value') { //two data elements inside a value: an error occurred! $GLOBALS['_xh']['isf'] = 2; $GLOBALS['_xh']['isf_reason'] = "$name element following a {$GLOBALS['_xh']['vt']} element inside a single value"; return; } // create an empty array to hold child values, and push it onto appropriate stack $cur_val = array(); $cur_val['values'] = array(); $cur_val['type'] = $name; // check for out-of-band information to rebuild php objs // and in case it is found, save it if (@isset($attrs['PHP_CLASS'])) { $cur_val['php_class'] = $attrs['PHP_CLASS']; } $GLOBALS['_xh']['valuestack'][] = $cur_val; $GLOBALS['_xh']['vt']='data'; // be prepared for a data element next break; case 'DATA': if ($GLOBALS['_xh']['vt']!='data') { //two data elements inside a value: an error occurred! $GLOBALS['_xh']['isf'] = 2; $GLOBALS['_xh']['isf_reason'] = "found two data elements inside an array element"; return; } case 'METHODCALL': case 'METHODRESPONSE': case 'PARAMS': // valid elements that add little to processing break; case 'METHODNAME': case 'NAME': /// @todo we could check for 2 NAME elements inside a MEMBER element $GLOBALS['_xh']['ac']=''; break; case 'FAULT': $GLOBALS['_xh']['isf']=1; break; case 'MEMBER': $GLOBALS['_xh']['valuestack'][count($GLOBALS['_xh']['valuestack'])-1]['name']=''; // set member name to null, in case we do not find in the xml later on //$GLOBALS['_xh']['ac']=''; // Drop trough intentionally case 'PARAM': // clear value type, so we can check later if no value has been passed for this param/member $GLOBALS['_xh']['vt']=null; break; case 'NIL': case 'EX:NIL': if ($GLOBALS['xmlrpc_null_extension']) { if ($GLOBALS['_xh']['vt']!='value') { //two data elements inside a value: an error occurred! $GLOBALS['_xh']['isf'] = 2; $GLOBALS['_xh']['isf_reason'] = "$name element following a {$GLOBALS['_xh']['vt']} element inside a single value"; return; } $GLOBALS['_xh']['ac']=''; // reset the accumulator break; } // we do not support the extension, so // drop through intentionally default: /// INVALID ELEMENT: RAISE ISF so that it is later recognized!!! $GLOBALS['_xh']['isf'] = 2; $GLOBALS['_xh']['isf_reason'] = "found not-xmlrpc xml element $name"; break; } // Save current element name to stack, to validate nesting $GLOBALS['_xh']['stack'][] = $name; /// @todo optimization creep: move this inside the big switch() above if($name!='VALUE') { $GLOBALS['_xh']['lv']=0; } } } /// Used in decoding xml chunks that might represent single xmlrpc values function xmlrpc_se_any($parser, $name, $attrs) { xmlrpc_se($parser, $name, $attrs, true); } /// xml parser handler function for close element tags function xmlrpc_ee($parser, $name, $rebuild_xmlrpcvals = true) { if ($GLOBALS['_xh']['isf'] < 2) { // push this element name from stack // NB: if XML validates, correct opening/closing is guaranteed and // we do not have to check for $name == $curr_elem. // we also checked for proper nesting at start of elements... $curr_elem = array_pop($GLOBALS['_xh']['stack']); switch($name) { case 'VALUE': // This if() detects if no scalar was inside if ($GLOBALS['_xh']['vt']=='value') { $GLOBALS['_xh']['value']=$GLOBALS['_xh']['ac']; $GLOBALS['_xh']['vt']=$GLOBALS['xmlrpcString']; } if ($rebuild_xmlrpcvals) { // build the xmlrpc val out of the data received, and substitute it $temp = new xmlrpcval($GLOBALS['_xh']['value'], $GLOBALS['_xh']['vt']); // in case we got info about underlying php class, save it // in the object we're rebuilding if (isset($GLOBALS['_xh']['php_class'])) $temp->_php_class = $GLOBALS['_xh']['php_class']; // check if we are inside an array or struct: // if value just built is inside an array, let's move it into array on the stack $vscount = count($GLOBALS['_xh']['valuestack']); if ($vscount && $GLOBALS['_xh']['valuestack'][$vscount-1]['type']=='ARRAY') { $GLOBALS['_xh']['valuestack'][$vscount-1]['values'][] = $temp; } else { $GLOBALS['_xh']['value'] = $temp; } } else { /// @todo this needs to treat correctly php-serialized objects, /// since std deserializing is done by php_xmlrpc_decode, /// which we will not be calling... if (isset($GLOBALS['_xh']['php_class'])) { } // check if we are inside an array or struct: // if value just built is inside an array, let's move it into array on the stack $vscount = count($GLOBALS['_xh']['valuestack']); if ($vscount && $GLOBALS['_xh']['valuestack'][$vscount-1]['type']=='ARRAY') { $GLOBALS['_xh']['valuestack'][$vscount-1]['values'][] = $GLOBALS['_xh']['value']; } } break; case 'BOOLEAN': case 'I4': case 'INT': case 'STRING': case 'DOUBLE': case 'DATETIME.ISO8601': case 'BASE64': $GLOBALS['_xh']['vt']=strtolower($name); /// @todo: optimization creep - remove the if/elseif cycle below /// since the case() in which we are already did that if ($name=='STRING') { $GLOBALS['_xh']['value']=$GLOBALS['_xh']['ac']; } elseif ($name=='DATETIME.ISO8601') { if (!preg_match('/^[0-9]{8}T[0-9]{2}:[0-9]{2}:[0-9]{2}$/', $GLOBALS['_xh']['ac'])) { error_log('XML-RPC: invalid value received in DATETIME: '.$GLOBALS['_xh']['ac']); } $GLOBALS['_xh']['vt']=$GLOBALS['xmlrpcDateTime']; $GLOBALS['_xh']['value']=$GLOBALS['_xh']['ac']; } elseif ($name=='BASE64') { /// @todo check for failure of base64 decoding / catch warnings $GLOBALS['_xh']['value']=base64_decode($GLOBALS['_xh']['ac']); } elseif ($name=='BOOLEAN') { // special case here: we translate boolean 1 or 0 into PHP // constants true or false. // Strings 'true' and 'false' are accepted, even though the // spec never mentions them (see eg. Blogger api docs) // NB: this simple checks helps a lot sanitizing input, ie no // security problems around here if ($GLOBALS['_xh']['ac']=='1' || strcasecmp($GLOBALS['_xh']['ac'], 'true') == 0) { $GLOBALS['_xh']['value']=true; } else { // log if receiveing something strange, even though we set the value to false anyway if ($GLOBALS['_xh']['ac']!='0' && strcasecmp($GLOBALS['_xh']['ac'], 'false') != 0) error_log('XML-RPC: invalid value received in BOOLEAN: '.$GLOBALS['_xh']['ac']); $GLOBALS['_xh']['value']=false; } } elseif ($name=='DOUBLE') { // we have a DOUBLE // we must check that only 0123456789-. are characters here // NOTE: regexp could be much stricter than this... if (!preg_match('/^[+-eE0123456789 \t.]+$/', $GLOBALS['_xh']['ac'])) { /// @todo: find a better way of throwing an error than this! error_log('XML-RPC: non numeric value received in DOUBLE: '.$GLOBALS['_xh']['ac']); $GLOBALS['_xh']['value']='ERROR_NON_NUMERIC_FOUND'; } else { // it's ok, add it on $GLOBALS['_xh']['value']=(double)$GLOBALS['_xh']['ac']; } } else { // we have an I4/INT // we must check that only 0123456789- are characters here if (!preg_match('/^[+-]?[0123456789 \t]+$/', $GLOBALS['_xh']['ac'])) { /// @todo find a better way of throwing an error than this! error_log('XML-RPC: non numeric value received in INT: '.$GLOBALS['_xh']['ac']); $GLOBALS['_xh']['value']='ERROR_NON_NUMERIC_FOUND'; } else { // it's ok, add it on $GLOBALS['_xh']['value']=(int)$GLOBALS['_xh']['ac']; } } //$GLOBALS['_xh']['ac']=''; // is this necessary? $GLOBALS['_xh']['lv']=3; // indicate we've found a value break; case 'NAME': $GLOBALS['_xh']['valuestack'][count($GLOBALS['_xh']['valuestack'])-1]['name'] = $GLOBALS['_xh']['ac']; break; case 'MEMBER': //$GLOBALS['_xh']['ac']=''; // is this necessary? // add to array in the stack the last element built, // unless no VALUE was found if ($GLOBALS['_xh']['vt']) { $vscount = count($GLOBALS['_xh']['valuestack']); $GLOBALS['_xh']['valuestack'][$vscount-1]['values'][$GLOBALS['_xh']['valuestack'][$vscount-1]['name']] = $GLOBALS['_xh']['value']; } else error_log('XML-RPC: missing VALUE inside STRUCT in received xml'); break; case 'DATA': //$GLOBALS['_xh']['ac']=''; // is this necessary? $GLOBALS['_xh']['vt']=null; // reset this to check for 2 data elements in a row - even if they're empty break; case 'STRUCT': case 'ARRAY': // fetch out of stack array of values, and promote it to current value $curr_val = array_pop($GLOBALS['_xh']['valuestack']); $GLOBALS['_xh']['value'] = $curr_val['values']; $GLOBALS['_xh']['vt']=strtolower($name); if (isset($curr_val['php_class'])) { $GLOBALS['_xh']['php_class'] = $curr_val['php_class']; } break; case 'PARAM': // add to array of params the current value, // unless no VALUE was found if ($GLOBALS['_xh']['vt']) { $GLOBALS['_xh']['params'][]=$GLOBALS['_xh']['value']; $GLOBALS['_xh']['pt'][]=$GLOBALS['_xh']['vt']; } else error_log('XML-RPC: missing VALUE inside PARAM in received xml'); break; case 'METHODNAME': $GLOBALS['_xh']['method']=preg_replace('/^[\n\r\t ]+/', '', $GLOBALS['_xh']['ac']); break; case 'NIL': case 'EX:NIL': if ($GLOBALS['xmlrpc_null_extension']) { $GLOBALS['_xh']['vt']='null'; $GLOBALS['_xh']['value']=null; $GLOBALS['_xh']['lv']=3; break; } // drop through intentionally if nil extension not enabled case 'PARAMS': case 'FAULT': case 'METHODCALL': case 'METHORESPONSE': break; default: // End of INVALID ELEMENT! // shall we add an assert here for unreachable code??? break; } } } /// Used in decoding xmlrpc requests/responses without rebuilding xmlrpc values function xmlrpc_ee_fast($parser, $name) { xmlrpc_ee($parser, $name, false); } /// xml parser handler function for character data function xmlrpc_cd($parser, $data) { // skip processing if xml fault already detected if ($GLOBALS['_xh']['isf'] < 2) { // "lookforvalue==3" means that we've found an entire value // and should discard any further character data if($GLOBALS['_xh']['lv']!=3) { // G. Giunta 2006-08-23: useless change of 'lv' from 1 to 2 //if($GLOBALS['_xh']['lv']==1) //{ // if we've found text and we're just in a then // say we've found a value //$GLOBALS['_xh']['lv']=2; //} // we always initialize the accumulator before starting parsing, anyway... //if(!@isset($GLOBALS['_xh']['ac'])) //{ // $GLOBALS['_xh']['ac'] = ''; //} $GLOBALS['_xh']['ac'].=$data; } } } /// xml parser handler function for 'other stuff', ie. not char data or /// element start/end tag. In fact it only gets called on unknown entities... function xmlrpc_dh($parser, $data) { // skip processing if xml fault already detected if ($GLOBALS['_xh']['isf'] < 2) { if(substr($data, 0, 1) == '&' && substr($data, -1, 1) == ';') { // G. Giunta 2006-08-25: useless change of 'lv' from 1 to 2 //if($GLOBALS['_xh']['lv']==1) //{ // $GLOBALS['_xh']['lv']=2; //} $GLOBALS['_xh']['ac'].=$data; } } return true; } class xmlrpc_client { var $path; var $server; var $port=0; var $method='http'; var $errno; var $errstr; var $debug=0; var $username=''; var $password=''; var $authtype=1; var $cert=''; var $certpass=''; var $cacert=''; var $cacertdir=''; var $key=''; var $keypass=''; var $verifypeer=true; var $verifyhost=1; var $no_multicall=false; var $proxy=''; var $proxyport=0; var $proxy_user=''; var $proxy_pass=''; var $proxy_authtype=1; var $cookies=array(); var $extracurlopts=array(); /** * List of http compression methods accepted by the client for responses. * NB: PHP supports deflate, gzip compressions out of the box if compiled w. zlib * * NNB: you can set it to any non-empty array for HTTP11 and HTTPS, since * in those cases it will be up to CURL to decide the compression methods * it supports. You might check for the presence of 'zlib' in the output of * curl_version() to determine wheter compression is supported or not */ var $accepted_compression = array(); /** * Name of compression scheme to be used for sending requests. * Either null, gzip or deflate */ var $request_compression = ''; /** * CURL handle: used for keep-alive connections (PHP 4.3.8 up, see: * http://curl.haxx.se/docs/faq.html#7.3) */ var $xmlrpc_curl_handle = null; /// Wheter to use persistent connections for http 1.1 and https var $keepalive = false; /// Charset encodings that can be decoded without problems by the client var $accepted_charset_encodings = array(); /// Charset encoding to be used in serializing request. NULL = use ASCII var $request_charset_encoding = ''; /** * Decides the content of xmlrpcresp objects returned by calls to send() * valid strings are 'xmlrpcvals', 'phpvals' or 'xml' */ var $return_type = 'xmlrpcvals'; /** * Sent to servers in http headers */ var $user_agent; /** * @param string $path either the complete server URL or the PATH part of the xmlrc server URL, e.g. /xmlrpc/server.php * @param string $server the server name / ip address * @param integer $port the port the server is listening on, defaults to 80 or 443 depending on protocol used * @param string $method the http protocol variant: defaults to 'http', 'https' and 'http11' can be used if CURL is installed */ function xmlrpc_client($path, $server='', $port='', $method='') { // allow user to specify all params in $path if($server == '' and $port == '' and $method == '') { $parts = parse_url($path); $server = $parts['host']; $path = isset($parts['path']) ? $parts['path'] : ''; if(isset($parts['query'])) { $path .= '?'.$parts['query']; } if(isset($parts['fragment'])) { $path .= '#'.$parts['fragment']; } if(isset($parts['port'])) { $port = $parts['port']; } if(isset($parts['scheme'])) { $method = $parts['scheme']; } if(isset($parts['user'])) { $this->username = $parts['user']; } if(isset($parts['pass'])) { $this->password = $parts['pass']; } } if($path == '' || $path[0] != '/') { $this->path='/'.$path; } else { $this->path=$path; } $this->server=$server; if($port != '') { $this->port=$port; } if($method != '') { $this->method=$method; } // if ZLIB is enabled, let the client by default accept compressed responses if(function_exists('gzinflate') || ( function_exists('curl_init') && (($info = curl_version()) && ((is_string($info) && strpos($info, 'zlib') !== null) || isset($info['libz_version']))) )) { $this->accepted_compression = array('gzip', 'deflate'); } // keepalives: enabled by default $this->keepalive = true; // by default the xml parser can support these 3 charset encodings $this->accepted_charset_encodings = array('UTF-8', 'ISO-8859-1', 'US-ASCII'); // initialize user_agent string $this->user_agent = $GLOBALS['xmlrpcName'] . ' ' . $GLOBALS['xmlrpcVersion']; } /** * Enables/disables the echoing to screen of the xmlrpc responses received * @param integer $debug values 0, 1 and 2 are supported (2 = echo sent msg too, before received response) * @access public */ function setDebug($in) { $this->debug=$in; } /** * Add some http BASIC AUTH credentials, used by the client to authenticate * @param string $u username * @param string $p password * @param integer $t auth type. See curl_setopt man page for supported auth types. Defaults to CURLAUTH_BASIC (basic auth) * @access public */ function setCredentials($u, $p, $t=1) { $this->username=$u; $this->password=$p; $this->authtype=$t; } /** * Add a client-side https certificate * @param string $cert * @param string $certpass * @access public */ function setCertificate($cert, $certpass) { $this->cert = $cert; $this->certpass = $certpass; } /** * Add a CA certificate to verify server with (see man page about * CURLOPT_CAINFO for more details * @param string $cacert certificate file name (or dir holding certificates) * @param bool $is_dir set to true to indicate cacert is a dir. defaults to false * @access public */ function setCaCertificate($cacert, $is_dir=false) { if ($is_dir) { $this->cacertdir = $cacert; } else { $this->cacert = $cacert; } } /** * Set attributes for SSL communication: private SSL key * NB: does not work in older php/curl installs * Thanks to Daniel Convissor * @param string $key The name of a file containing a private SSL key * @param string $keypass The secret password needed to use the private SSL key * @access public */ function setKey($key, $keypass) { $this->key = $key; $this->keypass = $keypass; } /** * Set attributes for SSL communication: verify server certificate * @param bool $i enable/disable verification of peer certificate * @access public */ function setSSLVerifyPeer($i) { $this->verifypeer = $i; } /** * Set attributes for SSL communication: verify match of server cert w. hostname * @param int $i * @access public */ function setSSLVerifyHost($i) { $this->verifyhost = $i; } /** * Set proxy info * @param string $proxyhost * @param string $proxyport Defaults to 8080 for HTTP and 443 for HTTPS * @param string $proxyusername Leave blank if proxy has public access * @param string $proxypassword Leave blank if proxy has public access * @param int $proxyauthtype set to constant CURLAUTH_NTLM to use NTLM auth with proxy * @access public */ function setProxy($proxyhost, $proxyport, $proxyusername = '', $proxypassword = '', $proxyauthtype = 1) { $this->proxy = $proxyhost; $this->proxyport = $proxyport; $this->proxy_user = $proxyusername; $this->proxy_pass = $proxypassword; $this->proxy_authtype = $proxyauthtype; } /** * Enables/disables reception of compressed xmlrpc responses. * Note that enabling reception of compressed responses merely adds some standard * http headers to xmlrpc requests. It is up to the xmlrpc server to return * compressed responses when receiving such requests. * @param string $compmethod either 'gzip', 'deflate', 'any' or '' * @access public */ function setAcceptedCompression($compmethod) { if ($compmethod == 'any') $this->accepted_compression = array('gzip', 'deflate'); else $this->accepted_compression = array($compmethod); } /** * Enables/disables http compression of xmlrpc request. * Take care when sending compressed requests: servers might not support them * (and automatic fallback to uncompressed requests is not yet implemented) * @param string $compmethod either 'gzip', 'deflate' or '' * @access public */ function setRequestCompression($compmethod) { $this->request_compression = $compmethod; } /** * Adds a cookie to list of cookies that will be sent to server. * NB: setting any param but name and value will turn the cookie into a 'version 1' cookie: * do not do it unless you know what you are doing * @param string $name * @param string $value * @param string $path * @param string $domain * @param int $port * @access public * * @todo check correctness of urlencoding cookie value (copied from php way of doing it...) */ function setCookie($name, $value='', $path='', $domain='', $port=null) { $this->cookies[$name]['value'] = urlencode($value); if ($path || $domain || $port) { $this->cookies[$name]['path'] = $path; $this->cookies[$name]['domain'] = $domain; $this->cookies[$name]['port'] = $port; $this->cookies[$name]['version'] = 1; } else { $this->cookies[$name]['version'] = 0; } } /** * Directly set cURL options, for extra flexibility * It allows eg. to bind client to a specific IP interface / address * @param $options array */ function SetCurlOptions( $options ) { $this->extracurlopts = $options; } /** * Set user-agent string that will be used by this client instance * in http headers sent to the server */ function SetUserAgent( $agentstring ) { $this->user_agent = $agentstring; } /** * Send an xmlrpc request * @param mixed $msg The message object, or an array of messages for using multicall, or the complete xml representation of a request * @param integer $timeout Connection timeout, in seconds, If unspecified, a platform specific timeout will apply * @param string $method if left unspecified, the http protocol chosen during creation of the object will be used * @return xmlrpcresp * @access public */ function& send($msg, $timeout=0, $method='') { // if user deos not specify http protocol, use native method of this client // (i.e. method set during call to constructor) if($method == '') { $method = $this->method; } if(is_array($msg)) { // $msg is an array of xmlrpcmsg's $r = $this->multicall($msg, $timeout, $method); return $r; } elseif(is_string($msg)) { $n = new xmlrpcmsg(''); $n->payload = $msg; $msg = $n; } // where msg is an xmlrpcmsg $msg->debug=$this->debug; if($method == 'https') { $r =& $this->sendPayloadHTTPS( $msg, $this->server, $this->port, $timeout, $this->username, $this->password, $this->authtype, $this->cert, $this->certpass, $this->cacert, $this->cacertdir, $this->proxy, $this->proxyport, $this->proxy_user, $this->proxy_pass, $this->proxy_authtype, $this->keepalive, $this->key, $this->keypass ); } elseif($method == 'http11') { $r =& $this->sendPayloadCURL( $msg, $this->server, $this->port, $timeout, $this->username, $this->password, $this->authtype, null, null, null, null, $this->proxy, $this->proxyport, $this->proxy_user, $this->proxy_pass, $this->proxy_authtype, 'http', $this->keepalive ); } else { $r =& $this->sendPayloadHTTP10( $msg, $this->server, $this->port, $timeout, $this->username, $this->password, $this->authtype, $this->proxy, $this->proxyport, $this->proxy_user, $this->proxy_pass, $this->proxy_authtype ); } return $r; } /** * @access private */ function &sendPayloadHTTP10($msg, $server, $port, $timeout=0, $username='', $password='', $authtype=1, $proxyhost='', $proxyport=0, $proxyusername='', $proxypassword='', $proxyauthtype=1) { if($port==0) { $port=80; } // Only create the payload if it was not created previously if(empty($msg->payload)) { $msg->createPayload($this->request_charset_encoding); } $payload = $msg->payload; // Deflate request body and set appropriate request headers if(function_exists('gzdeflate') && ($this->request_compression == 'gzip' || $this->request_compression == 'deflate')) { if($this->request_compression == 'gzip') { $a = @gzencode($payload); if($a) { $payload = $a; $encoding_hdr = "Content-Encoding: gzip\r\n"; } } else { $a = @gzcompress($payload); if($a) { $payload = $a; $encoding_hdr = "Content-Encoding: deflate\r\n"; } } } else { $encoding_hdr = ''; } // thanks to Grant Rauscher for this $credentials=''; if($username!='') { $credentials='Authorization: Basic ' . base64_encode($username . ':' . $password) . "\r\n"; if ($authtype != 1) { error_log('XML-RPC: '.__METHOD__.': warning. Only Basic auth is supported with HTTP 1.0'); } } $accepted_encoding = ''; if(is_array($this->accepted_compression) && count($this->accepted_compression)) { $accepted_encoding = 'Accept-Encoding: ' . implode(', ', $this->accepted_compression) . "\r\n"; } $proxy_credentials = ''; if($proxyhost) { if($proxyport == 0) { $proxyport = 8080; } $connectserver = $proxyhost; $connectport = $proxyport; $uri = 'http://'.$server.':'.$port.$this->path; if($proxyusername != '') { if ($proxyauthtype != 1) { error_log('XML-RPC: '.__METHOD__.': warning. Only Basic auth to proxy is supported with HTTP 1.0'); } $proxy_credentials = 'Proxy-Authorization: Basic ' . base64_encode($proxyusername.':'.$proxypassword) . "\r\n"; } } else { $connectserver = $server; $connectport = $port; $uri = $this->path; } // Cookie generation, as per rfc2965 (version 1 cookies) or // netscape's rules (version 0 cookies) $cookieheader=''; if (count($this->cookies)) { $version = ''; foreach ($this->cookies as $name => $cookie) { if ($cookie['version']) { $version = ' $Version="' . $cookie['version'] . '";'; $cookieheader .= ' ' . $name . '="' . $cookie['value'] . '";'; if ($cookie['path']) $cookieheader .= ' $Path="' . $cookie['path'] . '";'; if ($cookie['domain']) $cookieheader .= ' $Domain="' . $cookie['domain'] . '";'; if ($cookie['port']) $cookieheader .= ' $Port="' . $cookie['port'] . '";'; } else { $cookieheader .= ' ' . $name . '=' . $cookie['value'] . ";"; } } $cookieheader = 'Cookie:' . $version . substr($cookieheader, 0, -1) . "\r\n"; } $op= 'POST ' . $uri. " HTTP/1.0\r\n" . 'User-Agent: ' . $this->user_agent . "\r\n" . 'Host: '. $server . ':' . $port . "\r\n" . $credentials . $proxy_credentials . $accepted_encoding . $encoding_hdr . 'Accept-Charset: ' . implode(',', $this->accepted_charset_encodings) . "\r\n" . $cookieheader . 'Content-Type: ' . $msg->content_type . "\r\nContent-Length: " . strlen($payload) . "\r\n\r\n" . $payload; if($this->debug > 1) { print "
\n---SENDING---\n" . htmlentities($op) . "\n---END---\n
"; // let the client see this now in case http times out... flush(); } if($timeout>0) { $fp=@fsockopen($connectserver, $connectport, $this->errno, $this->errstr, $timeout); } else { $fp=@fsockopen($connectserver, $connectport, $this->errno, $this->errstr); } if($fp) { if($timeout>0 && function_exists('stream_set_timeout')) { stream_set_timeout($fp, $timeout); } } else { $this->errstr='Connect error: '.$this->errstr; $r=new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['http_error'], $this->errstr . ' (' . $this->errno . ')'); return $r; } if(!fputs($fp, $op, strlen($op))) { fclose($fp); $this->errstr='Write error'; $r=new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['http_error'], $this->errstr); return $r; } else { // reset errno and errstr on succesful socket connection $this->errstr = ''; } // G. Giunta 2005/10/24: close socket before parsing. // should yeld slightly better execution times, and make easier recursive calls (e.g. to follow http redirects) $ipd=''; do { // shall we check for $data === FALSE? // as per the manual, it signals an error $ipd.=fread($fp, 32768); } while(!feof($fp)); fclose($fp); $r =& $msg->parseResponse($ipd, false, $this->return_type); return $r; } /** * @access private */ function &sendPayloadHTTPS($msg, $server, $port, $timeout=0, $username='', $password='', $authtype=1, $cert='',$certpass='', $cacert='', $cacertdir='', $proxyhost='', $proxyport=0, $proxyusername='', $proxypassword='', $proxyauthtype=1, $keepalive=false, $key='', $keypass='') { $r =& $this->sendPayloadCURL($msg, $server, $port, $timeout, $username, $password, $authtype, $cert, $certpass, $cacert, $cacertdir, $proxyhost, $proxyport, $proxyusername, $proxypassword, $proxyauthtype, 'https', $keepalive, $key, $keypass); return $r; } /** * Contributed by Justin Miller * Requires curl to be built into PHP * NB: CURL versions before 7.11.10 cannot use proxy to talk to https servers! * @access private */ function &sendPayloadCURL($msg, $server, $port, $timeout=0, $username='', $password='', $authtype=1, $cert='', $certpass='', $cacert='', $cacertdir='', $proxyhost='', $proxyport=0, $proxyusername='', $proxypassword='', $proxyauthtype=1, $method='https', $keepalive=false, $key='', $keypass='') { if(!function_exists('curl_init')) { $this->errstr='CURL unavailable on this install'; $r=new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['no_curl'], $GLOBALS['xmlrpcstr']['no_curl']); return $r; } if($method == 'https') { if(($info = curl_version()) && ((is_string($info) && strpos($info, 'OpenSSL') === null) || (is_array($info) && !isset($info['ssl_version'])))) { $this->errstr='SSL unavailable on this install'; $r=new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['no_ssl'], $GLOBALS['xmlrpcstr']['no_ssl']); return $r; } } if($port == 0) { if($method == 'http') { $port = 80; } else { $port = 443; } } // Only create the payload if it was not created previously if(empty($msg->payload)) { $msg->createPayload($this->request_charset_encoding); } // Deflate request body and set appropriate request headers $payload = $msg->payload; if(function_exists('gzdeflate') && ($this->request_compression == 'gzip' || $this->request_compression == 'deflate')) { if($this->request_compression == 'gzip') { $a = @gzencode($payload); if($a) { $payload = $a; $encoding_hdr = 'Content-Encoding: gzip'; } } else { $a = @gzcompress($payload); if($a) { $payload = $a; $encoding_hdr = 'Content-Encoding: deflate'; } } } else { $encoding_hdr = ''; } if($this->debug > 1) { print "
\n---SENDING---\n" . htmlentities($payload) . "\n---END---\n
"; // let the client see this now in case http times out... flush(); } if(!$keepalive || !$this->xmlrpc_curl_handle) { $curl = curl_init($method . '://' . $server . ':' . $port . $this->path); if($keepalive) { $this->xmlrpc_curl_handle = $curl; } } else { $curl = $this->xmlrpc_curl_handle; } // results into variable curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1); if($this->debug) { curl_setopt($curl, CURLOPT_VERBOSE, 1); } curl_setopt($curl, CURLOPT_USERAGENT, $this->user_agent); // required for XMLRPC: post the data curl_setopt($curl, CURLOPT_POST, 1); // the data curl_setopt($curl, CURLOPT_POSTFIELDS, $payload); // return the header too curl_setopt($curl, CURLOPT_HEADER, 1); // will only work with PHP >= 5.0 // NB: if we set an empty string, CURL will add http header indicating // ALL methods it is supporting. This is possibly a better option than // letting the user tell what curl can / cannot do... if(is_array($this->accepted_compression) && count($this->accepted_compression)) { //curl_setopt($curl, CURLOPT_ENCODING, implode(',', $this->accepted_compression)); // empty string means 'any supported by CURL' (shall we catch errors in case CURLOPT_SSLKEY undefined ?) if (count($this->accepted_compression) == 1) { curl_setopt($curl, CURLOPT_ENCODING, $this->accepted_compression[0]); } else curl_setopt($curl, CURLOPT_ENCODING, ''); } // extra headers $headers = array('Content-Type: ' . $msg->content_type , 'Accept-Charset: ' . implode(',', $this->accepted_charset_encodings)); // if no keepalive is wanted, let the server know it in advance if(!$keepalive) { $headers[] = 'Connection: close'; } // request compression header if($encoding_hdr) { $headers[] = $encoding_hdr; } curl_setopt($curl, CURLOPT_HTTPHEADER, $headers); // timeout is borked if($timeout) { curl_setopt($curl, CURLOPT_TIMEOUT, $timeout == 1 ? 1 : $timeout - 1); } if($username && $password) { curl_setopt($curl, CURLOPT_USERPWD, $username.':'.$password); if (defined('CURLOPT_HTTPAUTH')) { curl_setopt($curl, CURLOPT_HTTPAUTH, $authtype); } else if ($authtype != 1) { error_log('XML-RPC: '.__METHOD__.': warning. Only Basic auth is supported by the current PHP/curl install'); } } if($method == 'https') { // set cert file if($cert) { curl_setopt($curl, CURLOPT_SSLCERT, $cert); } // set cert password if($certpass) { curl_setopt($curl, CURLOPT_SSLCERTPASSWD, $certpass); } // whether to verify remote host's cert curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, $this->verifypeer); // set ca certificates file/dir if($cacert) { curl_setopt($curl, CURLOPT_CAINFO, $cacert); } if($cacertdir) { curl_setopt($curl, CURLOPT_CAPATH, $cacertdir); } // set key file (shall we catch errors in case CURLOPT_SSLKEY undefined ?) if($key) { curl_setopt($curl, CURLOPT_SSLKEY, $key); } // set key password (shall we catch errors in case CURLOPT_SSLKEY undefined ?) if($keypass) { curl_setopt($curl, CURLOPT_SSLKEYPASSWD, $keypass); } // whether to verify cert's common name (CN); 0 for no, 1 to verify that it exists, and 2 to verify that it matches the hostname used curl_setopt($curl, CURLOPT_SSL_VERIFYHOST, $this->verifyhost); } // proxy info if($proxyhost) { if($proxyport == 0) { $proxyport = 8080; // NB: even for HTTPS, local connection is on port 8080 } curl_setopt($curl, CURLOPT_PROXY, $proxyhost.':'.$proxyport); //curl_setopt($curl, CURLOPT_PROXYPORT,$proxyport); if($proxyusername) { curl_setopt($curl, CURLOPT_PROXYUSERPWD, $proxyusername.':'.$proxypassword); if (defined('CURLOPT_PROXYAUTH')) { curl_setopt($curl, CURLOPT_PROXYAUTH, $proxyauthtype); } else if ($proxyauthtype != 1) { error_log('XML-RPC: '.__METHOD__.': warning. Only Basic auth to proxy is supported by the current PHP/curl install'); } } } // NB: should we build cookie http headers by hand rather than let CURL do it? // the following code does not honour 'expires', 'path' and 'domain' cookie attributes // set to client obj the the user... if (count($this->cookies)) { $cookieheader = ''; foreach ($this->cookies as $name => $cookie) { $cookieheader .= $name . '=' . $cookie['value'] . '; '; } curl_setopt($curl, CURLOPT_COOKIE, substr($cookieheader, 0, -2)); } foreach ($this->extracurlopts as $opt => $val) { curl_setopt($curl, $opt, $val); } $result = curl_exec($curl); if ($this->debug > 1) { print "
\n---CURL INFO---\n";
				foreach(curl_getinfo($curl) as $name => $val)
					 print $name . ': ' . htmlentities($val). "\n";
				print "---END---\n
"; } if(!$result) /// @todo we should use a better check here - what if we get back '' or '0'? { $this->errstr='no response'; $resp=new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['curl_fail'], $GLOBALS['xmlrpcstr']['curl_fail']. ': '. curl_error($curl)); curl_close($curl); if($keepalive) { $this->xmlrpc_curl_handle = null; } } else { if(!$keepalive) { curl_close($curl); } $resp =& $msg->parseResponse($result, true, $this->return_type); } return $resp; } /** * Send an array of request messages and return an array of responses. * Unless $this->no_multicall has been set to true, it will try first * to use one single xmlrpc call to server method system.multicall, and * revert to sending many successive calls in case of failure. * This failure is also stored in $this->no_multicall for subsequent calls. * Unfortunately, there is no server error code universally used to denote * the fact that multicall is unsupported, so there is no way to reliably * distinguish between that and a temporary failure. * If you are sure that server supports multicall and do not want to * fallback to using many single calls, set the fourth parameter to FALSE. * * NB: trying to shoehorn extra functionality into existing syntax has resulted * in pretty much convoluted code... * * @param array $msgs an array of xmlrpcmsg objects * @param integer $timeout connection timeout (in seconds) * @param string $method the http protocol variant to be used * @param boolean fallback When true, upon receiveing an error during multicall, multiple single calls will be attempted * @return array * @access public */ function multicall($msgs, $timeout=0, $method='', $fallback=true) { if ($method == '') { $method = $this->method; } if(!$this->no_multicall) { $results = $this->_try_multicall($msgs, $timeout, $method); if(is_array($results)) { // System.multicall succeeded return $results; } else { // either system.multicall is unsupported by server, // or call failed for some other reason. if ($fallback) { // Don't try it next time... $this->no_multicall = true; } else { if (is_a($results, 'xmlrpcresp')) { $result = $results; } else { $result = new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['multicall_error'], $GLOBALS['xmlrpcstr']['multicall_error']); } } } } else { // override fallback, in case careless user tries to do two // opposite things at the same time $fallback = true; } $results = array(); if ($fallback) { // system.multicall is (probably) unsupported by server: // emulate multicall via multiple requests foreach($msgs as $msg) { $results[] =& $this->send($msg, $timeout, $method); } } else { // user does NOT want to fallback on many single calls: // since we should always return an array of responses, // return an array with the same error repeated n times foreach($msgs as $msg) { $results[] = $result; } } return $results; } /** * Attempt to boxcar $msgs via system.multicall. * Returns either an array of xmlrpcreponses, an xmlrpc error response * or false (when received response does not respect valid multicall syntax) * @access private */ function _try_multicall($msgs, $timeout, $method) { // Construct multicall message $calls = array(); foreach($msgs as $msg) { $call['methodName'] = new xmlrpcval($msg->method(),'string'); $numParams = $msg->getNumParams(); $params = array(); for($i = 0; $i < $numParams; $i++) { $params[$i] = $msg->getParam($i); } $call['params'] = new xmlrpcval($params, 'array'); $calls[] = new xmlrpcval($call, 'struct'); } $multicall = new xmlrpcmsg('system.multicall'); $multicall->addParam(new xmlrpcval($calls, 'array')); // Attempt RPC call $result =& $this->send($multicall, $timeout, $method); if($result->faultCode() != 0) { // call to system.multicall failed return $result; } // Unpack responses. $rets = $result->value(); if ($this->return_type == 'xml') { return $rets; } else if ($this->return_type == 'phpvals') { ///@todo test this code branch... $rets = $result->value(); if(!is_array($rets)) { return false; // bad return type from system.multicall } $numRets = count($rets); if($numRets != count($msgs)) { return false; // wrong number of return values. } $response = array(); for($i = 0; $i < $numRets; $i++) { $val = $rets[$i]; if (!is_array($val)) { return false; } switch(count($val)) { case 1: if(!isset($val[0])) { return false; // Bad value } // Normal return value $response[$i] = new xmlrpcresp($val[0], 0, '', 'phpvals'); break; case 2: /// @todo remove usage of @: it is apparently quite slow $code = @$val['faultCode']; if(!is_int($code)) { return false; } $str = @$val['faultString']; if(!is_string($str)) { return false; } $response[$i] = new xmlrpcresp(0, $code, $str); break; default: return false; } } return $response; } else // return type == 'xmlrpcvals' { $rets = $result->value(); if($rets->kindOf() != 'array') { return false; // bad return type from system.multicall } $numRets = $rets->arraysize(); if($numRets != count($msgs)) { return false; // wrong number of return values. } $response = array(); for($i = 0; $i < $numRets; $i++) { $val = $rets->arraymem($i); switch($val->kindOf()) { case 'array': if($val->arraysize() != 1) { return false; // Bad value } // Normal return value $response[$i] = new xmlrpcresp($val->arraymem(0)); break; case 'struct': $code = $val->structmem('faultCode'); if($code->kindOf() != 'scalar' || $code->scalartyp() != 'int') { return false; } $str = $val->structmem('faultString'); if($str->kindOf() != 'scalar' || $str->scalartyp() != 'string') { return false; } $response[$i] = new xmlrpcresp(0, $code->scalarval(), $str->scalarval()); break; default: return false; } } return $response; } } } // end class xmlrpc_client class xmlrpcresp { var $val = 0; var $valtyp; var $errno = 0; var $errstr = ''; var $payload; var $hdrs = array(); var $_cookies = array(); var $content_type = 'text/xml'; var $raw_data = ''; /** * @param mixed $val either an xmlrpcval obj, a php value or the xml serialization of an xmlrpcval (a string) * @param integer $fcode set it to anything but 0 to create an error response * @param string $fstr the error string, in case of an error response * @param string $valtyp either 'xmlrpcvals', 'phpvals' or 'xml' * * @todo add check that $val / $fcode / $fstr is of correct type??? * NB: as of now we do not do it, since it might be either an xmlrpcval or a plain * php val, or a complete xml chunk, depending on usage of xmlrpc_client::send() inside which creator is called... */ function xmlrpcresp($val, $fcode = 0, $fstr = '', $valtyp='') { if($fcode != 0) { // error response $this->errno = $fcode; $this->errstr = $fstr; //$this->errstr = htmlspecialchars($fstr); // XXX: encoding probably shouldn't be done here; fix later. } else { // successful response $this->val = $val; if ($valtyp == '') { // user did not declare type of response value: try to guess it if (is_object($this->val) && is_a($this->val, 'xmlrpcval')) { $this->valtyp = 'xmlrpcvals'; } else if (is_string($this->val)) { $this->valtyp = 'xml'; } else { $this->valtyp = 'phpvals'; } } else { // user declares type of resp value: believe him $this->valtyp = $valtyp; } } } /** * Returns the error code of the response. * @return integer the error code of this response (0 for not-error responses) * @access public */ function faultCode() { return $this->errno; } /** * Returns the error code of the response. * @return string the error string of this response ('' for not-error responses) * @access public */ function faultString() { return $this->errstr; } /** * Returns the value received by the server. * @return mixed the xmlrpcval object returned by the server. Might be an xml string or php value if the response has been created by specially configured xmlrpc_client objects * @access public */ function value() { return $this->val; } /** * Returns an array with the cookies received from the server. * Array has the form: $cookiename => array ('value' => $val, $attr1 => $val1, $attr2 = $val2, ...) * with attributes being e.g. 'expires', 'path', domain'. * NB: cookies sent as 'expired' by the server (i.e. with an expiry date in the past) * are still present in the array. It is up to the user-defined code to decide * how to use the received cookies, and wheter they have to be sent back with the next * request to the server (using xmlrpc_client::setCookie) or not * @return array array of cookies received from the server * @access public */ function cookies() { return $this->_cookies; } /** * Returns xml representation of the response. XML prologue not included * @param string $charset_encoding the charset to be used for serialization. if null, US-ASCII is assumed * @return string the xml representation of the response * @access public */ function serialize($charset_encoding='') { if ($charset_encoding != '') $this->content_type = 'text/xml; charset=' . $charset_encoding; else $this->content_type = 'text/xml'; $result = "\n"; if($this->errno) { // G. Giunta 2005/2/13: let non-ASCII response messages be tolerated by clients // by xml-encoding non ascii chars $result .= "\n" . "\nfaultCode\n" . $this->errno . "\n\n\nfaultString\n" . xmlrpc_encode_entitites($this->errstr, $GLOBALS['xmlrpc_internalencoding'], $charset_encoding) . "\n\n" . "\n\n"; } else { if(!is_object($this->val) || !is_a($this->val, 'xmlrpcval')) { if (is_string($this->val) && $this->valtyp == 'xml') { $result .= "\n\n" . $this->val . "\n"; } else { /// @todo try to build something serializable? die('cannot serialize xmlrpcresp objects whose content is native php values'); } } else { $result .= "\n\n" . $this->val->serialize($charset_encoding) . "\n"; } } $result .= "\n"; $this->payload = $result; return $result; } } class xmlrpcmsg { var $payload; var $methodname; var $params=array(); var $debug=0; var $content_type = 'text/xml'; /** * @param string $meth the name of the method to invoke * @param array $pars array of parameters to be paased to the method (xmlrpcval objects) */ function xmlrpcmsg($meth, $pars=0) { $this->methodname=$meth; if(is_array($pars) && count($pars)>0) { for($i=0; $iaddParam($pars[$i]); } } } /** * @access private */ function xml_header($charset_encoding='') { if ($charset_encoding != '') { return "\n\n"; } else { return "\n\n"; } } /** * @access private */ function xml_footer() { return ''; } /** * @access private */ function kindOf() { return 'msg'; } /** * @access private */ function createPayload($charset_encoding='') { if ($charset_encoding != '') $this->content_type = 'text/xml; charset=' . $charset_encoding; else $this->content_type = 'text/xml'; $this->payload=$this->xml_header($charset_encoding); $this->payload.='' . $this->methodname . "\n"; $this->payload.="\n"; for($i=0; $iparams); $i++) { $p=$this->params[$i]; $this->payload.="\n" . $p->serialize($charset_encoding) . "\n"; } $this->payload.="\n"; $this->payload.=$this->xml_footer(); } /** * Gets/sets the xmlrpc method to be invoked * @param string $meth the method to be set (leave empty not to set it) * @return string the method that will be invoked * @access public */ function method($meth='') { if($meth!='') { $this->methodname=$meth; } return $this->methodname; } /** * Returns xml representation of the message. XML prologue included * @return string the xml representation of the message, xml prologue included * @access public */ function serialize($charset_encoding='') { $this->createPayload($charset_encoding); return $this->payload; } /** * Add a parameter to the list of parameters to be used upon method invocation * @param xmlrpcval $par * @return boolean false on failure * @access public */ function addParam($par) { // add check: do not add to self params which are not xmlrpcvals if(is_object($par) && is_a($par, 'xmlrpcval')) { $this->params[]=$par; return true; } else { return false; } } /** * Returns the nth parameter in the message. The index zero-based. * @param integer $i the index of the parameter to fetch (zero based) * @return xmlrpcval the i-th parameter * @access public */ function getParam($i) { return $this->params[$i]; } /** * Returns the number of parameters in the messge. * @return integer the number of parameters currently set * @access public */ function getNumParams() { return count($this->params); } /** * Given an open file handle, read all data available and parse it as axmlrpc response. * NB: the file handle is not closed by this function. * NNB: might have trouble in rare cases to work on network streams, as we * check for a read of 0 bytes instead of feof($fp). * But since checking for feof(null) returns false, we would risk an * infinite loop in that case, because we cannot trust the caller * to give us a valid pointer to an open file... * @access public * @return xmlrpcresp * @todo add 2nd & 3rd param to be passed to ParseResponse() ??? */ function &parseResponseFile($fp) { $ipd=''; while($data=fread($fp, 32768)) { $ipd.=$data; } //fclose($fp); $r =& $this->parseResponse($ipd); return $r; } /** * Parses HTTP headers and separates them from data. * @access private */ function &parseResponseHeaders(&$data, $headers_processed=false) { // Support "web-proxy-tunelling" connections for https through proxies if(preg_match('/^HTTP\/1\.[0-1] 200 Connection established/', $data)) { // Look for CR/LF or simple LF as line separator, // (even though it is not valid http) $pos = strpos($data,"\r\n\r\n"); if($pos || is_int($pos)) { $bd = $pos+4; } else { $pos = strpos($data,"\n\n"); if($pos || is_int($pos)) { $bd = $pos+2; } else { // No separation between response headers and body: fault? $bd = 0; } } if ($bd) { // this filters out all http headers from proxy. // maybe we could take them into account, too? $data = substr($data, $bd); } else { error_log('XML-RPC: '.__METHOD__.': HTTPS via proxy error, tunnel connection possibly failed'); $r=new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['http_error'], $GLOBALS['xmlrpcstr']['http_error']. ' (HTTPS via proxy error, tunnel connection possibly failed)'); return $r; } } // Strip HTTP 1.1 100 Continue header if present while(preg_match('/^HTTP\/1\.1 1[0-9]{2} /', $data)) { $pos = strpos($data, 'HTTP', 12); // server sent a Continue header without any (valid) content following... // give the client a chance to know it if(!$pos && !is_int($pos)) // works fine in php 3, 4 and 5 { break; } $data = substr($data, $pos); } if(!preg_match('/^HTTP\/[0-9.]+ 200 /', $data)) { $errstr= substr($data, 0, strpos($data, "\n")-1); error_log('XML-RPC: '.__METHOD__.': HTTP error, got response: ' .$errstr); $r=new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['http_error'], $GLOBALS['xmlrpcstr']['http_error']. ' (' . $errstr . ')'); return $r; } $GLOBALS['_xh']['headers'] = array(); $GLOBALS['_xh']['cookies'] = array(); // be tolerant to usage of \n instead of \r\n to separate headers and data // (even though it is not valid http) $pos = strpos($data,"\r\n\r\n"); if($pos || is_int($pos)) { $bd = $pos+4; } else { $pos = strpos($data,"\n\n"); if($pos || is_int($pos)) { $bd = $pos+2; } else { // No separation between response headers and body: fault? // we could take some action here instead of going on... $bd = 0; } } // be tolerant to line endings, and extra empty lines $ar = preg_split("/\r?\n/", trim(substr($data, 0, $pos))); while(list(,$line) = @each($ar)) { // take care of multi-line headers and cookies $arr = explode(':',$line,2); if(count($arr) > 1) { $header_name = strtolower(trim($arr[0])); /// @todo some other headers (the ones that allow a CSV list of values) /// do allow many values to be passed using multiple header lines. /// We should add content to $GLOBALS['_xh']['headers'][$header_name] /// instead of replacing it for those... if ($header_name == 'set-cookie' || $header_name == 'set-cookie2') { if ($header_name == 'set-cookie2') { // version 2 cookies: // there could be many cookies on one line, comma separated $cookies = explode(',', $arr[1]); } else { $cookies = array($arr[1]); } foreach ($cookies as $cookie) { // glue together all received cookies, using a comma to separate them // (same as php does with getallheaders()) if (isset($GLOBALS['_xh']['headers'][$header_name])) $GLOBALS['_xh']['headers'][$header_name] .= ', ' . trim($cookie); else $GLOBALS['_xh']['headers'][$header_name] = trim($cookie); // parse cookie attributes, in case user wants to correctly honour them // feature creep: only allow rfc-compliant cookie attributes? // @todo support for server sending multiple time cookie with same name, but using different PATHs $cookie = explode(';', $cookie); foreach ($cookie as $pos => $val) { $val = explode('=', $val, 2); $tag = trim($val[0]); $val = trim(@$val[1]); /// @todo with version 1 cookies, we should strip leading and trailing " chars if ($pos == 0) { $cookiename = $tag; $GLOBALS['_xh']['cookies'][$tag] = array(); $GLOBALS['_xh']['cookies'][$cookiename]['value'] = urldecode($val); } else { if ($tag != 'value') { $GLOBALS['_xh']['cookies'][$cookiename][$tag] = $val; } } } } } else { $GLOBALS['_xh']['headers'][$header_name] = trim($arr[1]); } } elseif(isset($header_name)) { /// @todo version1 cookies might span multiple lines, thus breaking the parsing above $GLOBALS['_xh']['headers'][$header_name] .= ' ' . trim($line); } } $data = substr($data, $bd); if($this->debug && count($GLOBALS['_xh']['headers'])) { print '
';
					foreach($GLOBALS['_xh']['headers'] as $header => $value)
					{
						print htmlentities("HEADER: $header: $value\n");
					}
					foreach($GLOBALS['_xh']['cookies'] as $header => $value)
					{
						print htmlentities("COOKIE: $header={$value['value']}\n");
					}
					print "
\n"; } // if CURL was used for the call, http headers have been processed, // and dechunking + reinflating have been carried out if(!$headers_processed) { // Decode chunked encoding sent by http 1.1 servers if(isset($GLOBALS['_xh']['headers']['transfer-encoding']) && $GLOBALS['_xh']['headers']['transfer-encoding'] == 'chunked') { if(!$data = decode_chunked($data)) { error_log('XML-RPC: '.__METHOD__.': errors occurred when trying to rebuild the chunked data received from server'); $r = new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['dechunk_fail'], $GLOBALS['xmlrpcstr']['dechunk_fail']); return $r; } } // Decode gzip-compressed stuff // code shamelessly inspired from nusoap library by Dietrich Ayala if(isset($GLOBALS['_xh']['headers']['content-encoding'])) { $GLOBALS['_xh']['headers']['content-encoding'] = str_replace('x-', '', $GLOBALS['_xh']['headers']['content-encoding']); if($GLOBALS['_xh']['headers']['content-encoding'] == 'deflate' || $GLOBALS['_xh']['headers']['content-encoding'] == 'gzip') { // if decoding works, use it. else assume data wasn't gzencoded if(function_exists('gzinflate')) { if($GLOBALS['_xh']['headers']['content-encoding'] == 'deflate' && $degzdata = @gzuncompress($data)) { $data = $degzdata; if($this->debug) print "
---INFLATED RESPONSE---[".strlen($data)." chars]---\n" . htmlentities($data) . "\n---END---
"; } elseif($GLOBALS['_xh']['headers']['content-encoding'] == 'gzip' && $degzdata = @gzinflate(substr($data, 10))) { $data = $degzdata; if($this->debug) print "
---INFLATED RESPONSE---[".strlen($data)." chars]---\n" . htmlentities($data) . "\n---END---
"; } else { error_log('XML-RPC: '.__METHOD__.': errors occurred when trying to decode the deflated data received from server'); $r = new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['decompress_fail'], $GLOBALS['xmlrpcstr']['decompress_fail']); return $r; } } else { error_log('XML-RPC: '.__METHOD__.': the server sent deflated data. Your php install must have the Zlib extension compiled in to support this.'); $r = new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['cannot_decompress'], $GLOBALS['xmlrpcstr']['cannot_decompress']); return $r; } } } } // end of 'if needed, de-chunk, re-inflate response' // real stupid hack to avoid PHP complaining about returning NULL by ref $r = null; $r =& $r; return $r; } /** * Parse the xmlrpc response contained in the string $data and return an xmlrpcresp object. * @param string $data the xmlrpc response, eventually including http headers * @param bool $headers_processed when true prevents parsing HTTP headers for interpretation of content-encoding and consequent decoding * @param string $return_type decides return type, i.e. content of response->value(). Either 'xmlrpcvals', 'xml' or 'phpvals' * @return xmlrpcresp * @access public */ function &parseResponse($data='', $headers_processed=false, $return_type='xmlrpcvals') { if($this->debug) { //by maHo, replaced htmlspecialchars with htmlentities print "
---GOT---\n" . htmlentities($data) . "\n---END---\n
"; } if($data == '') { error_log('XML-RPC: '.__METHOD__.': no response received from server.'); $r = new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['no_data'], $GLOBALS['xmlrpcstr']['no_data']); return $r; } $GLOBALS['_xh']=array(); $raw_data = $data; // parse the HTTP headers of the response, if present, and separate them from data if(substr($data, 0, 4) == 'HTTP') { $r =& $this->parseResponseHeaders($data, $headers_processed); if ($r) { // failed processing of HTTP response headers // save into response obj the full payload received, for debugging $r->raw_data = $data; return $r; } } else { $GLOBALS['_xh']['headers'] = array(); $GLOBALS['_xh']['cookies'] = array(); } if($this->debug) { $start = strpos($data, '', $start); $comments = substr($data, $start, $end-$start); print "
---SERVER DEBUG INFO (DECODED) ---\n\t".htmlentities(str_replace("\n", "\n\t", base64_decode($comments)))."\n---END---\n
"; } } // be tolerant of extra whitespace in response body $data = trim($data); /// @todo return an error msg if $data=='' ? // be tolerant of junk after methodResponse (e.g. javascript ads automatically inserted by free hosts) // idea from Luca Mariano originally in PEARified version of the lib $pos = strrpos($data, ''); if($pos !== false) { $data = substr($data, 0, $pos+17); } // if user wants back raw xml, give it to him if ($return_type == 'xml') { $r = new xmlrpcresp($data, 0, '', 'xml'); $r->hdrs = $GLOBALS['_xh']['headers']; $r->_cookies = $GLOBALS['_xh']['cookies']; $r->raw_data = $raw_data; return $r; } // try to 'guestimate' the character encoding of the received response $resp_encoding = guess_encoding(@$GLOBALS['_xh']['headers']['content-type'], $data); $GLOBALS['_xh']['ac']=''; //$GLOBALS['_xh']['qt']=''; //unused... $GLOBALS['_xh']['stack'] = array(); $GLOBALS['_xh']['valuestack'] = array(); $GLOBALS['_xh']['isf']=0; // 0 = OK, 1 for xmlrpc fault responses, 2 = invalid xmlrpc $GLOBALS['_xh']['isf_reason']=''; $GLOBALS['_xh']['rt']=''; // 'methodcall or 'methodresponse' // if response charset encoding is not known / supported, try to use // the default encoding and parse the xml anyway, but log a warning... if (!in_array($resp_encoding, array('UTF-8', 'ISO-8859-1', 'US-ASCII'))) // the following code might be better for mb_string enabled installs, but // makes the lib about 200% slower... //if (!is_valid_charset($resp_encoding, array('UTF-8', 'ISO-8859-1', 'US-ASCII'))) { error_log('XML-RPC: '.__METHOD__.': invalid charset encoding of received response: '.$resp_encoding); $resp_encoding = $GLOBALS['xmlrpc_defencoding']; } $parser = xml_parser_create($resp_encoding); xml_parser_set_option($parser, XML_OPTION_CASE_FOLDING, true); // G. Giunta 2005/02/13: PHP internally uses ISO-8859-1, so we have to tell // the xml parser to give us back data in the expected charset. // What if internal encoding is not in one of the 3 allowed? // we use the broadest one, ie. utf8 // This allows to send data which is native in various charset, // by extending xmlrpc_encode_entitites() and setting xmlrpc_internalencoding if (!in_array($GLOBALS['xmlrpc_internalencoding'], array('UTF-8', 'ISO-8859-1', 'US-ASCII'))) { xml_parser_set_option($parser, XML_OPTION_TARGET_ENCODING, 'UTF-8'); } else { xml_parser_set_option($parser, XML_OPTION_TARGET_ENCODING, $GLOBALS['xmlrpc_internalencoding']); } if ($return_type == 'phpvals') { xml_set_element_handler($parser, 'xmlrpc_se', 'xmlrpc_ee_fast'); } else { xml_set_element_handler($parser, 'xmlrpc_se', 'xmlrpc_ee'); } xml_set_character_data_handler($parser, 'xmlrpc_cd'); xml_set_default_handler($parser, 'xmlrpc_dh'); // first error check: xml not well formed if(!xml_parse($parser, $data, count($data))) { // thanks to Peter Kocks if((xml_get_current_line_number($parser)) == 1) { $errstr = 'XML error at line 1, check URL'; } else { $errstr = sprintf('XML error: %s at line %d, column %d', xml_error_string(xml_get_error_code($parser)), xml_get_current_line_number($parser), xml_get_current_column_number($parser)); } error_log($errstr); $r=new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['invalid_return'], $GLOBALS['xmlrpcstr']['invalid_return'].' ('.$errstr.')'); xml_parser_free($parser); if($this->debug) { print $errstr; } $r->hdrs = $GLOBALS['_xh']['headers']; $r->_cookies = $GLOBALS['_xh']['cookies']; $r->raw_data = $raw_data; return $r; } xml_parser_free($parser); // second error check: xml well formed but not xml-rpc compliant if ($GLOBALS['_xh']['isf'] > 1) { if ($this->debug) { /// @todo echo something for user? } $r = new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['invalid_return'], $GLOBALS['xmlrpcstr']['invalid_return'] . ' ' . $GLOBALS['_xh']['isf_reason']); } // third error check: parsing of the response has somehow gone boink. // NB: shall we omit this check, since we trust the parsing code? elseif ($return_type == 'xmlrpcvals' && !is_object($GLOBALS['_xh']['value'])) { // something odd has happened // and it's time to generate a client side error // indicating something odd went on $r=new xmlrpcresp(0, $GLOBALS['xmlrpcerr']['invalid_return'], $GLOBALS['xmlrpcstr']['invalid_return']); } else { if ($this->debug) { print "
---PARSED---\n";
					// somehow htmlentities chokes on var_export, and some full html string...
					//print htmlentitites(var_export($GLOBALS['_xh']['value'], true));
					print htmlspecialchars(var_export($GLOBALS['_xh']['value'], true));
					print "\n---END---
"; } // note that using =& will raise an error if $GLOBALS['_xh']['st'] does not generate an object. $v =& $GLOBALS['_xh']['value']; if($GLOBALS['_xh']['isf']) { /// @todo we should test here if server sent an int and a string, /// and/or coerce them into such... if ($return_type == 'xmlrpcvals') { $errno_v = $v->structmem('faultCode'); $errstr_v = $v->structmem('faultString'); $errno = $errno_v->scalarval(); $errstr = $errstr_v->scalarval(); } else { $errno = $v['faultCode']; $errstr = $v['faultString']; } if($errno == 0) { // FAULT returned, errno needs to reflect that $errno = -1; } $r = new xmlrpcresp(0, $errno, $errstr); } else { $r=new xmlrpcresp($v, 0, '', $return_type); } } $r->hdrs = $GLOBALS['_xh']['headers']; $r->_cookies = $GLOBALS['_xh']['cookies']; $r->raw_data = $raw_data; return $r; } } class xmlrpcval { var $me=array(); var $mytype=0; var $_php_class=null; /** * @param mixed $val * @param string $type any valid xmlrpc type name (lowercase). If null, 'string' is assumed */ function xmlrpcval($val=-1, $type='') { /// @todo: optimization creep - do not call addXX, do it all inline. /// downside: booleans will not be coerced anymore if($val!==-1 || $type!='') { // optimization creep: inlined all work done by constructor switch($type) { case '': $this->mytype=1; $this->me['string']=$val; break; case 'i4': case 'int': case 'double': case 'string': case 'boolean': case 'dateTime.iso8601': case 'base64': case 'null': $this->mytype=1; $this->me[$type]=$val; break; case 'array': $this->mytype=2; $this->me['array']=$val; break; case 'struct': $this->mytype=3; $this->me['struct']=$val; break; default: error_log("XML-RPC: ".__METHOD__.": not a known type ($type)"); } /*if($type=='') { $type='string'; } if($GLOBALS['xmlrpcTypes'][$type]==1) { $this->addScalar($val,$type); } elseif($GLOBALS['xmlrpcTypes'][$type]==2) { $this->addArray($val); } elseif($GLOBALS['xmlrpcTypes'][$type]==3) { $this->addStruct($val); }*/ } } /** * Add a single php value to an (unitialized) xmlrpcval * @param mixed $val * @param string $type * @return int 1 or 0 on failure */ function addScalar($val, $type='string') { $typeof=@$GLOBALS['xmlrpcTypes'][$type]; if($typeof!=1) { error_log("XML-RPC: ".__METHOD__.": not a scalar type ($type)"); return 0; } // coerce booleans into correct values // NB: we should either do it for datetimes, integers and doubles, too, // or just plain remove this check, implemented on booleans only... if($type==$GLOBALS['xmlrpcBoolean']) { if(strcasecmp($val,'true')==0 || $val==1 || ($val==true && strcasecmp($val,'false'))) { $val=true; } else { $val=false; } } switch($this->mytype) { case 1: error_log('XML-RPC: '.__METHOD__.': scalar xmlrpcval can have only one value'); return 0; case 3: error_log('XML-RPC: '.__METHOD__.': cannot add anonymous scalar to struct xmlrpcval'); return 0; case 2: // we're adding a scalar value to an array here //$ar=$this->me['array']; //$ar[]=new xmlrpcval($val, $type); //$this->me['array']=$ar; // Faster (?) avoid all the costly array-copy-by-val done here... $this->me['array'][]=new xmlrpcval($val, $type); return 1; default: // a scalar, so set the value and remember we're scalar $this->me[$type]=$val; $this->mytype=$typeof; return 1; } } /** * Add an array of xmlrpcval objects to an xmlrpcval * @param array $vals * @return int 1 or 0 on failure * @access public * * @todo add some checking for $vals to be an array of xmlrpcvals? */ function addArray($vals) { if($this->mytype==0) { $this->mytype=$GLOBALS['xmlrpcTypes']['array']; $this->me['array']=$vals; return 1; } elseif($this->mytype==2) { // we're adding to an array here $this->me['array'] = array_merge($this->me['array'], $vals); return 1; } else { error_log('XML-RPC: '.__METHOD__.': already initialized as a [' . $this->kindOf() . ']'); return 0; } } /** * Add an array of named xmlrpcval objects to an xmlrpcval * @param array $vals * @return int 1 or 0 on failure * @access public * * @todo add some checking for $vals to be an array? */ function addStruct($vals) { if($this->mytype==0) { $this->mytype=$GLOBALS['xmlrpcTypes']['struct']; $this->me['struct']=$vals; return 1; } elseif($this->mytype==3) { // we're adding to a struct here $this->me['struct'] = array_merge($this->me['struct'], $vals); return 1; } else { error_log('XML-RPC: '.__METHOD__.': already initialized as a [' . $this->kindOf() . ']'); return 0; } } // poor man's version of print_r ??? // DEPRECATED! function dump($ar) { foreach($ar as $key => $val) { echo "$key => $val
"; if($key == 'array') { while(list($key2, $val2) = each($val)) { echo "-- $key2 => $val2
"; } } } } /** * Returns a string containing "struct", "array" or "scalar" describing the base type of the value * @return string * @access public */ function kindOf() { switch($this->mytype) { case 3: return 'struct'; break; case 2: return 'array'; break; case 1: return 'scalar'; break; default: return 'undef'; } } /** * @access private */ function serializedata($typ, $val, $charset_encoding='') { $rs=''; switch(@$GLOBALS['xmlrpcTypes'][$typ]) { case 1: switch($typ) { case $GLOBALS['xmlrpcBase64']: $rs.="<${typ}>" . base64_encode($val) . ""; break; case $GLOBALS['xmlrpcBoolean']: $rs.="<${typ}>" . ($val ? '1' : '0') . ""; break; case $GLOBALS['xmlrpcString']: // G. Giunta 2005/2/13: do NOT use htmlentities, since // it will produce named html entities, which are invalid xml $rs.="<${typ}>" . xmlrpc_encode_entitites($val, $GLOBALS['xmlrpc_internalencoding'], $charset_encoding). ""; break; case $GLOBALS['xmlrpcInt']: case $GLOBALS['xmlrpcI4']: $rs.="<${typ}>".(int)$val.""; break; case $GLOBALS['xmlrpcDouble']: // avoid using standard conversion of float to string because it is locale-dependent, // and also because the xmlrpc spec forbids exponential notation. // sprintf('%F') could be most likely ok but it fails eg. on 2e-14. // The code below tries its best at keeping max precision while avoiding exp notation, // but there is of course no limit in the number of decimal places to be used... $rs.="<${typ}>".preg_replace('/\\.?0+$/','',number_format((double)$val, 128, '.', '')).""; break; case $GLOBALS['xmlrpcDateTime']: if (is_string($val)) { $rs.="<${typ}>${val}"; } else if(is_a($val, 'DateTime')) { $rs.="<${typ}>".$val->format('Ymd\TH:i:s').""; } else if(is_int($val)) { $rs.="<${typ}>".strftime("%Y%m%dT%H:%M:%S", $val).""; } else { // not really a good idea here: but what shall we output anyway? left for backward compat... $rs.="<${typ}>${val}"; } break; case $GLOBALS['xmlrpcNull']: if ($GLOBALS['xmlrpc_null_apache_encoding']) { $rs.=""; } else { $rs.=""; } break; default: // no standard type value should arrive here, but provide a possibility // for xmlrpcvals of unknown type... $rs.="<${typ}>${val}"; } break; case 3: // struct if ($this->_php_class) { $rs.='\n"; } else { $rs.="\n"; } foreach($val as $key2 => $val2) { $rs.=''.xmlrpc_encode_entitites($key2, $GLOBALS['xmlrpc_internalencoding'], $charset_encoding)."\n"; //$rs.=$this->serializeval($val2); $rs.=$val2->serialize($charset_encoding); $rs.="\n"; } $rs.=''; break; case 2: // array $rs.="\n\n"; for($i=0; $iserializeval($val[$i]); $rs.=$val[$i]->serialize($charset_encoding); } $rs.="\n"; break; default: break; } return $rs; } /** * Returns xml representation of the value. XML prologue not included * @param string $charset_encoding the charset to be used for serialization. if null, US-ASCII is assumed * @return string * @access public */ function serialize($charset_encoding='') { // add check? slower, but helps to avoid recursion in serializing broken xmlrpcvals... //if (is_object($o) && (get_class($o) == 'xmlrpcval' || is_subclass_of($o, 'xmlrpcval'))) //{ reset($this->me); list($typ, $val) = each($this->me); return '' . $this->serializedata($typ, $val, $charset_encoding) . "\n"; //} } // DEPRECATED function serializeval($o) { // add check? slower, but helps to avoid recursion in serializing broken xmlrpcvals... //if (is_object($o) && (get_class($o) == 'xmlrpcval' || is_subclass_of($o, 'xmlrpcval'))) //{ $ar=$o->me; reset($ar); list($typ, $val) = each($ar); return '' . $this->serializedata($typ, $val) . "\n"; //} } /** * Checks wheter a struct member with a given name is present. * Works only on xmlrpcvals of type struct. * @param string $m the name of the struct member to be looked up * @return boolean * @access public */ function structmemexists($m) { return array_key_exists($m, $this->me['struct']); } /** * Returns the value of a given struct member (an xmlrpcval object in itself). * Will raise a php warning if struct member of given name does not exist * @param string $m the name of the struct member to be looked up * @return xmlrpcval * @access public */ function structmem($m) { return $this->me['struct'][$m]; } /** * Reset internal pointer for xmlrpcvals of type struct. * @access public */ function structreset() { reset($this->me['struct']); } /** * Return next member element for xmlrpcvals of type struct. * @return xmlrpcval * @access public */ function structeach() { return each($this->me['struct']); } // DEPRECATED! this code looks like it is very fragile and has not been fixed // for a long long time. Shall we remove it for 2.0? function getval() { // UNSTABLE reset($this->me); list($a,$b)=each($this->me); // contributed by I Sofer, 2001-03-24 // add support for nested arrays to scalarval // i've created a new method here, so as to // preserve back compatibility if(is_array($b)) { @reset($b); while(list($id,$cont) = @each($b)) { $b[$id] = $cont->scalarval(); } } // add support for structures directly encoding php objects if(is_object($b)) { $t = get_object_vars($b); @reset($t); while(list($id,$cont) = @each($t)) { $t[$id] = $cont->scalarval(); } @reset($t); while(list($id,$cont) = @each($t)) { @$b->$id = $cont; } } // end contrib return $b; } /** * Returns the value of a scalar xmlrpcval * @return mixed * @access public */ function scalarval() { reset($this->me); list(,$b)=each($this->me); return $b; } /** * Returns the type of the xmlrpcval. * For integers, 'int' is always returned in place of 'i4' * @return string * @access public */ function scalartyp() { reset($this->me); list($a,)=each($this->me); if($a==$GLOBALS['xmlrpcI4']) { $a=$GLOBALS['xmlrpcInt']; } return $a; } /** * Returns the m-th member of an xmlrpcval of struct type * @param integer $m the index of the value to be retrieved (zero based) * @return xmlrpcval * @access public */ function arraymem($m) { return $this->me['array'][$m]; } /** * Returns the number of members in an xmlrpcval of array type * @return integer * @access public */ function arraysize() { return count($this->me['array']); } /** * Returns the number of members in an xmlrpcval of struct type * @return integer * @access public */ function structsize() { return count($this->me['struct']); } } // date helpers /** * Given a timestamp, return the corresponding ISO8601 encoded string. * * Really, timezones ought to be supported * but the XML-RPC spec says: * * "Don't assume a timezone. It should be specified by the server in its * documentation what assumptions it makes about timezones." * * These routines always assume localtime unless * $utc is set to 1, in which case UTC is assumed * and an adjustment for locale is made when encoding * * @param int $timet (timestamp) * @param int $utc (0 or 1) * @return string */ function iso8601_encode($timet, $utc=0) { if(!$utc) { $t=strftime("%Y%m%dT%H:%M:%S", $timet); } else { if(function_exists('gmstrftime')) { // gmstrftime doesn't exist in some versions // of PHP $t=gmstrftime("%Y%m%dT%H:%M:%S", $timet); } else { $t=strftime("%Y%m%dT%H:%M:%S", $timet-date('Z')); } } return $t; } /** * Given an ISO8601 date string, return a timet in the localtime, or UTC * @param string $idate * @param int $utc either 0 or 1 * @return int (datetime) */ function iso8601_decode($idate, $utc=0) { $t=0; if(preg_match('/([0-9]{4})([0-9]{2})([0-9]{2})T([0-9]{2}):([0-9]{2}):([0-9]{2})/', $idate, $regs)) { if($utc) { $t=gmmktime($regs[4], $regs[5], $regs[6], $regs[2], $regs[3], $regs[1]); } else { $t=mktime($regs[4], $regs[5], $regs[6], $regs[2], $regs[3], $regs[1]); } } return $t; } /** * Takes an xmlrpc value in PHP xmlrpcval object format and translates it into native PHP types. * * Works with xmlrpc message objects as input, too. * * Given proper options parameter, can rebuild generic php object instances * (provided those have been encoded to xmlrpc format using a corresponding * option in php_xmlrpc_encode()) * PLEASE NOTE that rebuilding php objects involves calling their constructor function. * This means that the remote communication end can decide which php code will * get executed on your server, leaving the door possibly open to 'php-injection' * style of attacks (provided you have some classes defined on your server that * might wreak havoc if instances are built outside an appropriate context). * Make sure you trust the remote server/client before eanbling this! * * @author Dan Libby (dan@libby.com) * * @param xmlrpcval $xmlrpc_val * @param array $options if 'decode_php_objs' is set in the options array, xmlrpc structs can be decoded into php objects; if 'dates_as_objects' is set xmlrpc datetimes are decoded as php DateTime objects (standard is * @return mixed */ function php_xmlrpc_decode($xmlrpc_val, $options=array()) { switch($xmlrpc_val->kindOf()) { case 'scalar': if (in_array('extension_api', $options)) { reset($xmlrpc_val->me); list($typ,$val) = each($xmlrpc_val->me); switch ($typ) { case 'dateTime.iso8601': $xmlrpc_val->scalar = $val; $xmlrpc_val->xmlrpc_type = 'datetime'; $xmlrpc_val->timestamp = iso8601_decode($val); return $xmlrpc_val; case 'base64': $xmlrpc_val->scalar = $val; $xmlrpc_val->type = $typ; return $xmlrpc_val; default: return $xmlrpc_val->scalarval(); } } if (in_array('dates_as_objects', $options) && $xmlrpc_val->scalartyp() == 'dateTime.iso8601') { // we return a Datetime object instead of a string // since now the constructor of xmlrpcval accepts safely strings, ints and datetimes, // we cater to all 3 cases here $out = $xmlrpc_val->scalarval(); if (is_string($out)) { $out = strtotime($out); } if (is_int($out)) { $result = new Datetime(); $result->setTimestamp($out); return $result; } elseif (is_a($out, 'Datetime')) { return $out; } } return $xmlrpc_val->scalarval(); case 'array': $size = $xmlrpc_val->arraysize(); $arr = array(); for($i = 0; $i < $size; $i++) { $arr[] = php_xmlrpc_decode($xmlrpc_val->arraymem($i), $options); } return $arr; case 'struct': $xmlrpc_val->structreset(); // If user said so, try to rebuild php objects for specific struct vals. /// @todo should we raise a warning for class not found? // shall we check for proper subclass of xmlrpcval instead of // presence of _php_class to detect what we can do? if (in_array('decode_php_objs', $options) && $xmlrpc_val->_php_class != '' && class_exists($xmlrpc_val->_php_class)) { $obj = @new $xmlrpc_val->_php_class; while(list($key,$value)=$xmlrpc_val->structeach()) { $obj->$key = php_xmlrpc_decode($value, $options); } return $obj; } else { $arr = array(); while(list($key,$value)=$xmlrpc_val->structeach()) { $arr[$key] = php_xmlrpc_decode($value, $options); } return $arr; } case 'msg': $paramcount = $xmlrpc_val->getNumParams(); $arr = array(); for($i = 0; $i < $paramcount; $i++) { $arr[] = php_xmlrpc_decode($xmlrpc_val->getParam($i)); } return $arr; } } // This constant left here only for historical reasons... // it was used to decide if we have to define xmlrpc_encode on our own, but // we do not do it anymore if(function_exists('xmlrpc_decode')) { define('XMLRPC_EPI_ENABLED','1'); } else { define('XMLRPC_EPI_ENABLED','0'); } /** * Takes native php types and encodes them into xmlrpc PHP object format. * It will not re-encode xmlrpcval objects. * * Feature creep -- could support more types via optional type argument * (string => datetime support has been added, ??? => base64 not yet) * * If given a proper options parameter, php object instances will be encoded * into 'special' xmlrpc values, that can later be decoded into php objects * by calling php_xmlrpc_decode() with a corresponding option * * @author Dan Libby (dan@libby.com) * * @param mixed $php_val the value to be converted into an xmlrpcval object * @param array $options can include 'encode_php_objs', 'auto_dates', 'null_extension' or 'extension_api' * @return xmlrpcval */ function php_xmlrpc_encode($php_val, $options=array()) { $type = gettype($php_val); switch($type) { case 'string': if (in_array('auto_dates', $options) && preg_match('/^[0-9]{8}T[0-9]{2}:[0-9]{2}:[0-9]{2}$/', $php_val)) $xmlrpc_val = new xmlrpcval($php_val, $GLOBALS['xmlrpcDateTime']); else $xmlrpc_val = new xmlrpcval($php_val, $GLOBALS['xmlrpcString']); break; case 'integer': $xmlrpc_val = new xmlrpcval($php_val, $GLOBALS['xmlrpcInt']); break; case 'double': $xmlrpc_val = new xmlrpcval($php_val, $GLOBALS['xmlrpcDouble']); break; // // Add support for encoding/decoding of booleans, since they are supported in PHP case 'boolean': $xmlrpc_val = new xmlrpcval($php_val, $GLOBALS['xmlrpcBoolean']); break; // case 'array': // PHP arrays can be encoded to either xmlrpc structs or arrays, // depending on wheter they are hashes or plain 0..n integer indexed // A shorter one-liner would be // $tmp = array_diff(array_keys($php_val), range(0, count($php_val)-1)); // but execution time skyrockets! $j = 0; $arr = array(); $ko = false; foreach($php_val as $key => $val) { $arr[$key] = php_xmlrpc_encode($val, $options); if(!$ko && $key !== $j) { $ko = true; } $j++; } if($ko) { $xmlrpc_val = new xmlrpcval($arr, $GLOBALS['xmlrpcStruct']); } else { $xmlrpc_val = new xmlrpcval($arr, $GLOBALS['xmlrpcArray']); } break; case 'object': if(is_a($php_val, 'xmlrpcval')) { $xmlrpc_val = $php_val; } else if(is_a($php_val, 'DateTime')) { $xmlrpc_val = new xmlrpcval($php_val->format('Ymd\TH:i:s'), $GLOBALS['xmlrpcStruct']); } else { $arr = array(); reset($php_val); while(list($k,$v) = each($php_val)) { $arr[$k] = php_xmlrpc_encode($v, $options); } $xmlrpc_val = new xmlrpcval($arr, $GLOBALS['xmlrpcStruct']); if (in_array('encode_php_objs', $options)) { // let's save original class name into xmlrpcval: // might be useful later on... $xmlrpc_val->_php_class = get_class($php_val); } } break; case 'NULL': if (in_array('extension_api', $options)) { $xmlrpc_val = new xmlrpcval('', $GLOBALS['xmlrpcString']); } else if (in_array('null_extension', $options)) { $xmlrpc_val = new xmlrpcval('', $GLOBALS['xmlrpcNull']); } else { $xmlrpc_val = new xmlrpcval(); } break; case 'resource': if (in_array('extension_api', $options)) { $xmlrpc_val = new xmlrpcval((int)$php_val, $GLOBALS['xmlrpcInt']); } else { $xmlrpc_val = new xmlrpcval(); } // catch "user function", "unknown type" default: // giancarlo pinerolo // it has to return // an empty object in case, not a boolean. $xmlrpc_val = new xmlrpcval(); break; } return $xmlrpc_val; } /** * Convert the xml representation of a method response, method request or single * xmlrpc value into the appropriate object (a.k.a. deserialize) * @param string $xml_val * @param array $options * @return mixed false on error, or an instance of either xmlrpcval, xmlrpcmsg or xmlrpcresp */ function php_xmlrpc_decode_xml($xml_val, $options=array()) { $GLOBALS['_xh'] = array(); $GLOBALS['_xh']['ac'] = ''; $GLOBALS['_xh']['stack'] = array(); $GLOBALS['_xh']['valuestack'] = array(); $GLOBALS['_xh']['params'] = array(); $GLOBALS['_xh']['pt'] = array(); $GLOBALS['_xh']['isf'] = 0; $GLOBALS['_xh']['isf_reason'] = ''; $GLOBALS['_xh']['method'] = false; $GLOBALS['_xh']['rt'] = ''; /// @todo 'guestimate' encoding $parser = xml_parser_create(); xml_parser_set_option($parser, XML_OPTION_CASE_FOLDING, true); // What if internal encoding is not in one of the 3 allowed? // we use the broadest one, ie. utf8! if (!in_array($GLOBALS['xmlrpc_internalencoding'], array('UTF-8', 'ISO-8859-1', 'US-ASCII'))) { xml_parser_set_option($parser, XML_OPTION_TARGET_ENCODING, 'UTF-8'); } else { xml_parser_set_option($parser, XML_OPTION_TARGET_ENCODING, $GLOBALS['xmlrpc_internalencoding']); } xml_set_element_handler($parser, 'xmlrpc_se_any', 'xmlrpc_ee'); xml_set_character_data_handler($parser, 'xmlrpc_cd'); xml_set_default_handler($parser, 'xmlrpc_dh'); if(!xml_parse($parser, $xml_val, 1)) { $errstr = sprintf('XML error: %s at line %d, column %d', xml_error_string(xml_get_error_code($parser)), xml_get_current_line_number($parser), xml_get_current_column_number($parser)); error_log($errstr); xml_parser_free($parser); return false; } xml_parser_free($parser); if ($GLOBALS['_xh']['isf'] > 1) // test that $GLOBALS['_xh']['value'] is an obj, too??? { error_log($GLOBALS['_xh']['isf_reason']); return false; } switch ($GLOBALS['_xh']['rt']) { case 'methodresponse': $v =& $GLOBALS['_xh']['value']; if ($GLOBALS['_xh']['isf'] == 1) { $vc = $v->structmem('faultCode'); $vs = $v->structmem('faultString'); $r = new xmlrpcresp(0, $vc->scalarval(), $vs->scalarval()); } else { $r = new xmlrpcresp($v); } return $r; case 'methodcall': $m = new xmlrpcmsg($GLOBALS['_xh']['method']); for($i=0; $i < count($GLOBALS['_xh']['params']); $i++) { $m->addParam($GLOBALS['_xh']['params'][$i]); } return $m; case 'value': return $GLOBALS['_xh']['value']; default: return false; } } /** * decode a string that is encoded w/ "chunked" transfer encoding * as defined in rfc2068 par. 19.4.6 * code shamelessly stolen from nusoap library by Dietrich Ayala * * @param string $buffer the string to be decoded * @return string */ function decode_chunked($buffer) { // length := 0 $length = 0; $new = ''; // read chunk-size, chunk-extension (if any) and crlf // get the position of the linebreak $chunkend = strpos($buffer,"\r\n") + 2; $temp = substr($buffer,0,$chunkend); $chunk_size = hexdec( trim($temp) ); $chunkstart = $chunkend; while($chunk_size > 0) { $chunkend = strpos($buffer, "\r\n", $chunkstart + $chunk_size); // just in case we got a broken connection if($chunkend == false) { $chunk = substr($buffer,$chunkstart); // append chunk-data to entity-body $new .= $chunk; $length += strlen($chunk); break; } // read chunk-data and crlf $chunk = substr($buffer,$chunkstart,$chunkend-$chunkstart); // append chunk-data to entity-body $new .= $chunk; // length := length + chunk-size $length += strlen($chunk); // read chunk-size and crlf $chunkstart = $chunkend + 2; $chunkend = strpos($buffer,"\r\n",$chunkstart)+2; if($chunkend == false) { break; //just in case we got a broken connection } $temp = substr($buffer,$chunkstart,$chunkend-$chunkstart); $chunk_size = hexdec( trim($temp) ); $chunkstart = $chunkend; } return $new; } /** * xml charset encoding guessing helper function. * Tries to determine the charset encoding of an XML chunk received over HTTP. * NB: according to the spec (RFC 3023), if text/xml content-type is received over HTTP without a content-type, * we SHOULD assume it is strictly US-ASCII. But we try to be more tolerant of unconforming (legacy?) clients/servers, * which will be most probably using UTF-8 anyway... * * @param string $httpheaders the http Content-type header * @param string $xmlchunk xml content buffer * @param string $encoding_prefs comma separated list of character encodings to be used as default (when mb extension is enabled) * * @todo explore usage of mb_http_input(): does it detect http headers + post data? if so, use it instead of hand-detection!!! */ function guess_encoding($httpheader='', $xmlchunk='', $encoding_prefs=null) { // discussion: see http://www.yale.edu/pclt/encoding/ // 1 - test if encoding is specified in HTTP HEADERS //Details: // LWS: (\13\10)?( |\t)+ // token: (any char but excluded stuff)+ // quoted string: " (any char but double quotes and cointrol chars)* " // header: Content-type = ...; charset=value(; ...)* // where value is of type token, no LWS allowed between 'charset' and value // Note: we do not check for invalid chars in VALUE: // this had better be done using pure ereg as below // Note 2: we might be removing whitespace/tabs that ought to be left in if // the received charset is a quoted string. But nobody uses such charset names... /// @todo this test will pass if ANY header has charset specification, not only Content-Type. Fix it? $matches = array(); if(preg_match('/;\s*charset\s*=([^;]+)/i', $httpheader, $matches)) { return strtoupper(trim($matches[1], " \t\"")); } // 2 - scan the first bytes of the data for a UTF-16 (or other) BOM pattern // (source: http://www.w3.org/TR/2000/REC-xml-20001006) // NOTE: actually, according to the spec, even if we find the BOM and determine // an encoding, we should check if there is an encoding specified // in the xml declaration, and verify if they match. /// @todo implement check as described above? /// @todo implement check for first bytes of string even without a BOM? (It sure looks harder than for cases WITH a BOM) if(preg_match('/^(\x00\x00\xFE\xFF|\xFF\xFE\x00\x00|\x00\x00\xFF\xFE|\xFE\xFF\x00\x00)/', $xmlchunk)) { return 'UCS-4'; } elseif(preg_match('/^(\xFE\xFF|\xFF\xFE)/', $xmlchunk)) { return 'UTF-16'; } elseif(preg_match('/^(\xEF\xBB\xBF)/', $xmlchunk)) { return 'UTF-8'; } // 3 - test if encoding is specified in the xml declaration // Details: // SPACE: (#x20 | #x9 | #xD | #xA)+ === [ \x9\xD\xA]+ // EQ: SPACE?=SPACE? === [ \x9\xD\xA]*=[ \x9\xD\xA]* if (preg_match('/^<\?xml\s+version\s*=\s*'. "((?:\"[a-zA-Z0-9_.:-]+\")|(?:'[a-zA-Z0-9_.:-]+'))". '\s+encoding\s*=\s*' . "((?:\"[A-Za-z][A-Za-z0-9._-]*\")|(?:'[A-Za-z][A-Za-z0-9._-]*'))/", $xmlchunk, $matches)) { return strtoupper(substr($matches[2], 1, -1)); } // 4 - if mbstring is available, let it do the guesswork // NB: we favour finding an encoding that is compatible with what we can process if(extension_loaded('mbstring')) { if($encoding_prefs) { $enc = mb_detect_encoding($xmlchunk, $encoding_prefs); } else { $enc = mb_detect_encoding($xmlchunk); } // NB: mb_detect likes to call it ascii, xml parser likes to call it US_ASCII... // IANA also likes better US-ASCII, so go with it if($enc == 'ASCII') { $enc = 'US-'.$enc; } return $enc; } else { // no encoding specified: as per HTTP1.1 assume it is iso-8859-1? // Both RFC 2616 (HTTP 1.1) and 1945 (HTTP 1.0) clearly state that for text/xxx content types // this should be the standard. And we should be getting text/xml as request and response. // BUT we have to be backward compatible with the lib, which always used UTF-8 as default... return $GLOBALS['xmlrpc_defencoding']; } } /** * Checks if a given charset encoding is present in a list of encodings or * if it is a valid subset of any encoding in the list * @param string $encoding charset to be tested * @param mixed $validlist comma separated list of valid charsets (or array of charsets) */ function is_valid_charset($encoding, $validlist) { $charset_supersets = array( 'US-ASCII' => array ('ISO-8859-1', 'ISO-8859-2', 'ISO-8859-3', 'ISO-8859-4', 'ISO-8859-5', 'ISO-8859-6', 'ISO-8859-7', 'ISO-8859-8', 'ISO-8859-9', 'ISO-8859-10', 'ISO-8859-11', 'ISO-8859-12', 'ISO-8859-13', 'ISO-8859-14', 'ISO-8859-15', 'UTF-8', 'EUC-JP', 'EUC-', 'EUC-KR', 'EUC-CN') ); if (is_string($validlist)) $validlist = explode(',', $validlist); if (@in_array(strtoupper($encoding), $validlist)) return true; else { if (array_key_exists($encoding, $charset_supersets)) foreach ($validlist as $allowed) if (in_array($allowed, $charset_supersets[$encoding])) return true; return false; } } ?>transport/xmlrpc-3.0.0.beta/lib/xmlrpc_wrappers.inc000066600000105226151375520470016167 0ustar00' . $funcname[1]; } $exists = method_exists($funcname[0], $funcname[1]); if (!$exists && version_compare(phpversion(), '5.1') < 0) { // workaround for php 5.0: static class methods are not seen by method_exists $exists = is_callable( $funcname ); } } else { $plainfuncname = $funcname; $exists = function_exists($funcname); } if(!$exists) { error_log('XML-RPC: function to be wrapped is not defined: '.$plainfuncname); return false; } else { // determine name of new php function if($newfuncname == '') { if(is_array($funcname)) { if(is_string($funcname[0])) $xmlrpcfuncname = "{$prefix}_".implode('_', $funcname); else $xmlrpcfuncname = "{$prefix}_".get_class($funcname[0]) . '_' . $funcname[1]; } else { $xmlrpcfuncname = "{$prefix}_$funcname"; } } else { $xmlrpcfuncname = $newfuncname; } while($buildit && function_exists($xmlrpcfuncname)) { $xmlrpcfuncname .= 'x'; } // start to introspect PHP code if(is_array($funcname)) { $func = new ReflectionMethod($funcname[0], $funcname[1]); if($func->isPrivate()) { error_log('XML-RPC: method to be wrapped is private: '.$plainfuncname); return false; } if($func->isProtected()) { error_log('XML-RPC: method to be wrapped is protected: '.$plainfuncname); return false; } if($func->isConstructor()) { error_log('XML-RPC: method to be wrapped is the constructor: '.$plainfuncname); return false; } // php 503 always says isdestructor = true... if( version_compare(phpversion(), '5.0.3') != 0 && $func->isDestructor()) { error_log('XML-RPC: method to be wrapped is the destructor: '.$plainfuncname); return false; } if($func->isAbstract()) { error_log('XML-RPC: method to be wrapped is abstract: '.$plainfuncname); return false; } /// @todo add more checks for static vs. nonstatic? } else { $func = new ReflectionFunction($funcname); } if($func->isInternal()) { // Note: from PHP 5.1.0 onward, we will possibly be able to use invokeargs // instead of getparameters to fully reflect internal php functions ? error_log('XML-RPC: function to be wrapped is internal: '.$plainfuncname); return false; } // retrieve parameter names, types and description from javadoc comments // function description $desc = ''; // type of return val: by default 'any' $returns = $GLOBALS['xmlrpcValue']; // desc of return val $returnsDocs = ''; // type + name of function parameters $paramDocs = array(); $docs = $func->getDocComment(); if($docs != '') { $docs = explode("\n", $docs); $i = 0; foreach($docs as $doc) { $doc = trim($doc, " \r\t/*"); if(strlen($doc) && strpos($doc, '@') !== 0 && !$i) { if($desc) { $desc .= "\n"; } $desc .= $doc; } elseif(strpos($doc, '@param') === 0) { // syntax: @param type [$name] desc if(preg_match('/@param\s+(\S+)(\s+\$\S+)?\s+(.+)/', $doc, $matches)) { if(strpos($matches[1], '|')) { //$paramDocs[$i]['type'] = explode('|', $matches[1]); $paramDocs[$i]['type'] = 'mixed'; } else { $paramDocs[$i]['type'] = $matches[1]; } $paramDocs[$i]['name'] = trim($matches[2]); $paramDocs[$i]['doc'] = $matches[3]; } $i++; } elseif(strpos($doc, '@return') === 0) { // syntax: @return type desc //$returns = preg_split('/\s+/', $doc); if(preg_match('/@return\s+(\S+)\s+(.+)/', $doc, $matches)) { $returns = php_2_xmlrpc_type($matches[1]); if(isset($matches[2])) { $returnsDocs = $matches[2]; } } } } } // execute introspection of actual function prototype $params = array(); $i = 0; foreach($func->getParameters() as $paramobj) { $params[$i] = array(); $params[$i]['name'] = '$'.$paramobj->getName(); $params[$i]['isoptional'] = $paramobj->isOptional(); $i++; } // start building of PHP code to be eval'd $innercode = ''; $i = 0; $parsvariations = array(); $pars = array(); $pnum = count($params); foreach($params as $param) { if (isset($paramDocs[$i]['name']) && $paramDocs[$i]['name'] && strtolower($paramDocs[$i]['name']) != strtolower($param['name'])) { // param name from phpdoc info does not match param definition! $paramDocs[$i]['type'] = 'mixed'; } if($param['isoptional']) { // this particular parameter is optional. save as valid previous list of parameters $innercode .= "if (\$paramcount > $i) {\n"; $parsvariations[] = $pars; } $innercode .= "\$p$i = \$msg->getParam($i);\n"; if ($decode_php_objects) { $innercode .= "if (\$p{$i}->kindOf() == 'scalar') \$p$i = \$p{$i}->scalarval(); else \$p$i = php_{$prefix}_decode(\$p$i, array('decode_php_objs'));\n"; } else { $innercode .= "if (\$p{$i}->kindOf() == 'scalar') \$p$i = \$p{$i}->scalarval(); else \$p$i = php_{$prefix}_decode(\$p$i);\n"; } $pars[] = "\$p$i"; $i++; if($param['isoptional']) { $innercode .= "}\n"; } if($i == $pnum) { // last allowed parameters combination $parsvariations[] = $pars; } } $sigs = array(); $psigs = array(); if(count($parsvariations) == 0) { // only known good synopsis = no parameters $parsvariations[] = array(); $minpars = 0; } else { $minpars = count($parsvariations[0]); } if($minpars) { // add to code the check for min params number // NB: this check needs to be done BEFORE decoding param values $innercode = "\$paramcount = \$msg->getNumParams();\n" . "if (\$paramcount < $minpars) return new {$prefix}resp(0, {$GLOBALS['xmlrpcerr']['incorrect_params']}, '{$GLOBALS['xmlrpcstr']['incorrect_params']}');\n" . $innercode; } else { $innercode = "\$paramcount = \$msg->getNumParams();\n" . $innercode; } $innercode .= "\$np = false;\n"; // since there are no closures in php, if we are given an object instance, // we store a pointer to it in a global var... if ( is_array($funcname) && is_object($funcname[0]) ) { $GLOBALS['xmlrpcWPFObjHolder'][$xmlrpcfuncname] =& $funcname[0]; $innercode .= "\$obj =& \$GLOBALS['xmlrpcWPFObjHolder']['$xmlrpcfuncname'];\n"; $realfuncname = '$obj->'.$funcname[1]; } else { $realfuncname = $plainfuncname; } foreach($parsvariations as $pars) { $innercode .= "if (\$paramcount == " . count($pars) . ") \$retval = {$catch_warnings}$realfuncname(" . implode(',', $pars) . "); else\n"; // build a 'generic' signature (only use an appropriate return type) $sig = array($returns); $psig = array($returnsDocs); for($i=0; $i < count($pars); $i++) { if (isset($paramDocs[$i]['type'])) { $sig[] = php_2_xmlrpc_type($paramDocs[$i]['type']); } else { $sig[] = $GLOBALS['xmlrpcValue']; } $psig[] = isset($paramDocs[$i]['doc']) ? $paramDocs[$i]['doc'] : ''; } $sigs[] = $sig; $psigs[] = $psig; } $innercode .= "\$np = true;\n"; $innercode .= "if (\$np) return new {$prefix}resp(0, {$GLOBALS['xmlrpcerr']['incorrect_params']}, '{$GLOBALS['xmlrpcstr']['incorrect_params']}'); else {\n"; //$innercode .= "if (\$_xmlrpcs_error_occurred) return new xmlrpcresp(0, $GLOBALS['xmlrpcerr']user, \$_xmlrpcs_error_occurred); else\n"; $innercode .= "if (is_a(\$retval, '{$prefix}resp')) return \$retval; else\n"; if($returns == $GLOBALS['xmlrpcDateTime'] || $returns == $GLOBALS['xmlrpcBase64']) { $innercode .= "return new {$prefix}resp(new {$prefix}val(\$retval, '$returns'));"; } else { if ($encode_php_objects) $innercode .= "return new {$prefix}resp(php_{$prefix}_encode(\$retval, array('encode_php_objs')));\n"; else $innercode .= "return new {$prefix}resp(php_{$prefix}_encode(\$retval));\n"; } // shall we exclude functions returning by ref? // if($func->returnsReference()) // return false; $code = "function $xmlrpcfuncname(\$msg) {\n" . $innercode . "}\n}"; //print_r($code); if ($buildit) { $allOK = 0; eval($code.'$allOK=1;'); // alternative //$xmlrpcfuncname = create_function('$m', $innercode); if(!$allOK) { error_log('XML-RPC: could not create function '.$xmlrpcfuncname.' to wrap php function '.$plainfuncname); return false; } } /// @todo examine if $paramDocs matches $parsvariations and build array for /// usage as method signature, plus put together a nice string for docs $ret = array('function' => $xmlrpcfuncname, 'signature' => $sigs, 'docstring' => $desc, 'signature_docs' => $psigs, 'source' => $code); return $ret; } } /** * Given a user-defined PHP class or php object, map its methods onto a list of * PHP 'wrapper' functions that can be exposed as xmlrpc methods from an xmlrpc_server * object and called from remote clients (as well as their corresponding signature info). * * @param mixed $classname the name of the class whose methods are to be exposed as xmlrpc methods, or an object instance of that class * @param array $extra_options see the docs for wrap_php_method for more options * string method_type 'static', 'nonstatic', 'all' and 'auto' (default); the latter will switch between static and non-static depending on wheter $classname is a class name or object instance * @return array or false on failure * * @todo get_class_methods will return both static and non-static methods. * we have to differentiate the action, depending on wheter we recived a class name or object */ function wrap_php_class($classname, $extra_options=array()) { $methodfilter = isset($extra_options['method_filter']) ? $extra_options['method_filter'] : ''; $methodtype = isset($extra_options['method_type']) ? $extra_options['method_type'] : 'auto'; if(version_compare(phpversion(), '5.0.3') == -1) { // up to php 5.0.3 some useful reflection methods were missing error_log('XML-RPC: cannot not wrap php functions unless running php version bigger than 5.0.3'); return false; } $result = array(); $mlist = get_class_methods($classname); foreach($mlist as $mname) { if ($methodfilter == '' || preg_match($methodfilter, $mname)) { // echo $mlist."\n"; $func = new ReflectionMethod($classname, $mname); if(!$func->isPrivate() && !$func->isProtected() && !$func->isConstructor() && !$func->isDestructor() && !$func->isAbstract()) { if(($func->isStatic && ($methodtype == 'all' || $methodtype == 'static' || ($methodtype == 'auto' && is_string($classname)))) || (!$func->isStatic && ($methodtype == 'all' || $methodtype == 'nonstatic' || ($methodtype == 'auto' && is_object($classname))))) { $methodwrap = wrap_php_function(array($classname, $mname), '', $extra_options); if ( $methodwrap ) { $result[$methodwrap['function']] = $methodwrap['function']; } } } } } return $result; } /** * Given an xmlrpc client and a method name, register a php wrapper function * that will call it and return results using native php types for both * params and results. The generated php function will return an xmlrpcresp * oject for failed xmlrpc calls * * Known limitations: * - server must support system.methodsignature for the wanted xmlrpc method * - for methods that expose many signatures, only one can be picked (we * could in priciple check if signatures differ only by number of params * and not by type, but it would be more complication than we can spare time) * - nested xmlrpc params: the caller of the generated php function has to * encode on its own the params passed to the php function if these are structs * or arrays whose (sub)members include values of type datetime or base64 * * Notes: the connection properties of the given client will be copied * and reused for the connection used during the call to the generated * php function. * Calling the generated php function 'might' be slow: a new xmlrpc client * is created on every invocation and an xmlrpc-connection opened+closed. * An extra 'debug' param is appended to param list of xmlrpc method, useful * for debugging purposes. * * @param xmlrpc_client $client an xmlrpc client set up correctly to communicate with target server * @param string $methodname the xmlrpc method to be mapped to a php function * @param array $extra_options array of options that specify conversion details. valid ptions include * integer signum the index of the method signature to use in mapping (if method exposes many sigs) * integer timeout timeout (in secs) to be used when executing function/calling remote method * string protocol 'http' (default), 'http11' or 'https' * string new_function_name the name of php function to create. If unsepcified, lib will pick an appropriate name * string return_source if true return php code w. function definition instead fo function name * bool encode_php_objs let php objects be sent to server using the 'improved' xmlrpc notation, so server can deserialize them as php objects * bool decode_php_objs --- WARNING !!! possible security hazard. only use it with trusted servers --- * mixed return_on_fault a php value to be returned when the xmlrpc call fails/returns a fault response (by default the xmlrpcresp object is returned in this case). If a string is used, '%faultCode%' and '%faultString%' tokens will be substituted with actual error values * bool debug set it to 1 or 2 to see debug results of querying server for method synopsis * @return string the name of the generated php function (or false) - OR AN ARRAY... */ function wrap_xmlrpc_method($client, $methodname, $extra_options=0, $timeout=0, $protocol='', $newfuncname='') { // mind numbing: let caller use sane calling convention (as per javadoc, 3 params), // OR the 2.0 calling convention (no options) - we really love backward compat, don't we? if (!is_array($extra_options)) { $signum = $extra_options; $extra_options = array(); } else { $signum = isset($extra_options['signum']) ? (int)$extra_options['signum'] : 0; $timeout = isset($extra_options['timeout']) ? (int)$extra_options['timeout'] : 0; $protocol = isset($extra_options['protocol']) ? $extra_options['protocol'] : ''; $newfuncname = isset($extra_options['new_function_name']) ? $extra_options['new_function_name'] : ''; } //$encode_php_objects = in_array('encode_php_objects', $extra_options); //$verbatim_client_copy = in_array('simple_client_copy', $extra_options) ? 1 : // in_array('build_class_code', $extra_options) ? 2 : 0; $encode_php_objects = isset($extra_options['encode_php_objs']) ? (bool)$extra_options['encode_php_objs'] : false; $decode_php_objects = isset($extra_options['decode_php_objs']) ? (bool)$extra_options['decode_php_objs'] : false; $simple_client_copy = isset($extra_options['simple_client_copy']) ? (int)($extra_options['simple_client_copy']) : 0; $buildit = isset($extra_options['return_source']) ? !($extra_options['return_source']) : true; $prefix = isset($extra_options['prefix']) ? $extra_options['prefix'] : 'xmlrpc'; if (isset($extra_options['return_on_fault'])) { $decode_fault = true; $fault_response = $extra_options['return_on_fault']; } else { $decode_fault = false; $fault_response = ''; } $debug = isset($extra_options['debug']) ? ($extra_options['debug']) : 0; $msgclass = $prefix.'msg'; $valclass = $prefix.'val'; $decodefunc = 'php_'.$prefix.'_decode'; $msg = new $msgclass('system.methodSignature'); $msg->addparam(new $valclass($methodname)); $client->setDebug($debug); $response =& $client->send($msg, $timeout, $protocol); if($response->faultCode()) { error_log('XML-RPC: could not retrieve method signature from remote server for method '.$methodname); return false; } else { $msig = $response->value(); if ($client->return_type != 'phpvals') { $msig = $decodefunc($msig); } if(!is_array($msig) || count($msig) <= $signum) { error_log('XML-RPC: could not retrieve method signature nr.'.$signum.' from remote server for method '.$methodname); return false; } else { // pick a suitable name for the new function, avoiding collisions if($newfuncname != '') { $xmlrpcfuncname = $newfuncname; } else { // take care to insure that methodname is translated to valid // php function name $xmlrpcfuncname = $prefix.'_'.preg_replace(array('/\./', '/[^a-zA-Z0-9_\x7f-\xff]/'), array('_', ''), $methodname); } while($buildit && function_exists($xmlrpcfuncname)) { $xmlrpcfuncname .= 'x'; } $msig = $msig[$signum]; $mdesc = ''; // if in 'offline' mode, get method description too. // in online mode, favour speed of operation if(!$buildit) { $msg = new $msgclass('system.methodHelp'); $msg->addparam(new $valclass($methodname)); $response =& $client->send($msg, $timeout, $protocol); if (!$response->faultCode()) { $mdesc = $response->value(); if ($client->return_type != 'phpvals') { $mdesc = $mdesc->scalarval(); } } } $results = build_remote_method_wrapper_code($client, $methodname, $xmlrpcfuncname, $msig, $mdesc, $timeout, $protocol, $simple_client_copy, $prefix, $decode_php_objects, $encode_php_objects, $decode_fault, $fault_response); //print_r($code); if ($buildit) { $allOK = 0; eval($results['source'].'$allOK=1;'); // alternative //$xmlrpcfuncname = create_function('$m', $innercode); if($allOK) { return $xmlrpcfuncname; } else { error_log('XML-RPC: could not create function '.$xmlrpcfuncname.' to wrap remote method '.$methodname); return false; } } else { $results['function'] = $xmlrpcfuncname; return $results; } } } } /** * Similar to wrap_xmlrpc_method, but will generate a php class that wraps * all xmlrpc methods exposed by the remote server as own methods. * For more details see wrap_xmlrpc_method. * @param xmlrpc_client $client the client obj all set to query the desired server * @param array $extra_options list of options for wrapped code * @return mixed false on error, the name of the created class if all ok or an array with code, class name and comments (if the appropriatevoption is set in extra_options) */ function wrap_xmlrpc_server($client, $extra_options=array()) { $methodfilter = isset($extra_options['method_filter']) ? $extra_options['method_filter'] : ''; //$signum = isset($extra_options['signum']) ? (int)$extra_options['signum'] : 0; $timeout = isset($extra_options['timeout']) ? (int)$extra_options['timeout'] : 0; $protocol = isset($extra_options['protocol']) ? $extra_options['protocol'] : ''; $newclassname = isset($extra_options['new_class_name']) ? $extra_options['new_class_name'] : ''; $encode_php_objects = isset($extra_options['encode_php_objs']) ? (bool)$extra_options['encode_php_objs'] : false; $decode_php_objects = isset($extra_options['decode_php_objs']) ? (bool)$extra_options['decode_php_objs'] : false; $verbatim_client_copy = isset($extra_options['simple_client_copy']) ? !($extra_options['simple_client_copy']) : true; $buildit = isset($extra_options['return_source']) ? !($extra_options['return_source']) : true; $prefix = isset($extra_options['prefix']) ? $extra_options['prefix'] : 'xmlrpc'; $msgclass = $prefix.'msg'; //$valclass = $prefix.'val'; $decodefunc = 'php_'.$prefix.'_decode'; $msg = new $msgclass('system.listMethods'); $response =& $client->send($msg, $timeout, $protocol); if($response->faultCode()) { error_log('XML-RPC: could not retrieve method list from remote server'); return false; } else { $mlist = $response->value(); if ($client->return_type != 'phpvals') { $mlist = $decodefunc($mlist); } if(!is_array($mlist) || !count($mlist)) { error_log('XML-RPC: could not retrieve meaningful method list from remote server'); return false; } else { // pick a suitable name for the new function, avoiding collisions if($newclassname != '') { $xmlrpcclassname = $newclassname; } else { $xmlrpcclassname = $prefix.'_'.preg_replace(array('/\./', '/[^a-zA-Z0-9_\x7f-\xff]/'), array('_', ''), $client->server).'_client'; } while($buildit && class_exists($xmlrpcclassname)) { $xmlrpcclassname .= 'x'; } /// @todo add function setdebug() to new class, to enable/disable debugging $source = "class $xmlrpcclassname\n{\nvar \$client;\n\n"; $source .= "function $xmlrpcclassname()\n{\n"; $source .= build_client_wrapper_code($client, $verbatim_client_copy, $prefix); $source .= "\$this->client =& \$client;\n}\n\n"; $opts = array('simple_client_copy' => 2, 'return_source' => true, 'timeout' => $timeout, 'protocol' => $protocol, 'encode_php_objs' => $encode_php_objects, 'prefix' => $prefix, 'decode_php_objs' => $decode_php_objects ); /// @todo build javadoc for class definition, too foreach($mlist as $mname) { if ($methodfilter == '' || preg_match($methodfilter, $mname)) { $opts['new_function_name'] = preg_replace(array('/\./', '/[^a-zA-Z0-9_\x7f-\xff]/'), array('_', ''), $mname); $methodwrap = wrap_xmlrpc_method($client, $mname, $opts); if ($methodwrap) { if (!$buildit) { $source .= $methodwrap['docstring']; } $source .= $methodwrap['source']."\n"; } else { error_log('XML-RPC: will not create class method to wrap remote method '.$mname); } } } $source .= "}\n"; if ($buildit) { $allOK = 0; eval($source.'$allOK=1;'); // alternative //$xmlrpcfuncname = create_function('$m', $innercode); if($allOK) { return $xmlrpcclassname; } else { error_log('XML-RPC: could not create class '.$xmlrpcclassname.' to wrap remote server '.$client->server); return false; } } else { return array('class' => $xmlrpcclassname, 'code' => $source, 'docstring' => ''); } } } } /** * Given the necessary info, build php code that creates a new function to * invoke a remote xmlrpc method. * Take care that no full checking of input parameters is done to ensure that * valid php code is emitted. * Note: real spaghetti code follows... * @access private */ function build_remote_method_wrapper_code($client, $methodname, $xmlrpcfuncname, $msig, $mdesc='', $timeout=0, $protocol='', $client_copy_mode=0, $prefix='xmlrpc', $decode_php_objects=false, $encode_php_objects=false, $decode_fault=false, $fault_response='') { $code = "function $xmlrpcfuncname ("; if ($client_copy_mode < 2) { // client copy mode 0 or 1 == partial / full client copy in emitted code $innercode = build_client_wrapper_code($client, $client_copy_mode, $prefix); $innercode .= "\$client->setDebug(\$debug);\n"; $this_ = ''; } else { // client copy mode 2 == no client copy in emitted code $innercode = ''; $this_ = 'this->'; } $innercode .= "\$msg = new {$prefix}msg('$methodname');\n"; if ($mdesc != '') { // take care that PHP comment is not terminated unwillingly by method description $mdesc = "/**\n* ".str_replace('*/', '* /', $mdesc)."\n"; } else { $mdesc = "/**\nFunction $xmlrpcfuncname\n"; } // param parsing $plist = array(); $pcount = count($msig); for($i = 1; $i < $pcount; $i++) { $plist[] = "\$p$i"; $ptype = $msig[$i]; if($ptype == 'i4' || $ptype == 'int' || $ptype == 'boolean' || $ptype == 'double' || $ptype == 'string' || $ptype == 'dateTime.iso8601' || $ptype == 'base64' || $ptype == 'null') { // only build directly xmlrpcvals when type is known and scalar $innercode .= "\$p$i = new {$prefix}val(\$p$i, '$ptype');\n"; } else { if ($encode_php_objects) { $innercode .= "\$p$i =& php_{$prefix}_encode(\$p$i, array('encode_php_objs'));\n"; } else { $innercode .= "\$p$i =& php_{$prefix}_encode(\$p$i);\n"; } } $innercode .= "\$msg->addparam(\$p$i);\n"; $mdesc .= '* @param '.xmlrpc_2_php_type($ptype)." \$p$i\n"; } if ($client_copy_mode < 2) { $plist[] = '$debug=0'; $mdesc .= "* @param int \$debug when 1 (or 2) will enable debugging of the underlying {$prefix} call (defaults to 0)\n"; } $plist = implode(', ', $plist); $mdesc .= '* @return '.xmlrpc_2_php_type($msig[0])." (or an {$prefix}resp obj instance if call fails)\n*/\n"; $innercode .= "\$res =& \${$this_}client->send(\$msg, $timeout, '$protocol');\n"; if ($decode_fault) { if (is_string($fault_response) && ((strpos($fault_response, '%faultCode%') !== false) || (strpos($fault_response, '%faultString%') !== false))) { $respcode = "str_replace(array('%faultCode%', '%faultString%'), array(\$res->faultCode(), \$res->faultString()), '".str_replace("'", "''", $fault_response)."')"; } else { $respcode = var_export($fault_response, true); } } else { $respcode = '$res'; } if ($decode_php_objects) { $innercode .= "if (\$res->faultcode()) return $respcode; else return php_{$prefix}_decode(\$res->value(), array('decode_php_objs'));"; } else { $innercode .= "if (\$res->faultcode()) return $respcode; else return php_{$prefix}_decode(\$res->value());"; } $code = $code . $plist. ") {\n" . $innercode . "\n}\n"; return array('source' => $code, 'docstring' => $mdesc); } /** * Given necessary info, generate php code that will rebuild a client object * Take care that no full checking of input parameters is done to ensure that * valid php code is emitted. * @access private */ function build_client_wrapper_code($client, $verbatim_client_copy, $prefix='xmlrpc') { $code = "\$client = new {$prefix}_client('".str_replace("'", "\'", $client->path). "', '" . str_replace("'", "\'", $client->server) . "', $client->port);\n"; // copy all client fields to the client that will be generated runtime // (this provides for future expansion or subclassing of client obj) if ($verbatim_client_copy) { foreach($client as $fld => $val) { if($fld != 'debug' && $fld != 'return_type') { $val = var_export($val, true); $code .= "\$client->$fld = $val;\n"; } } } // only make sure that client always returns the correct data type $code .= "\$client->return_type = '{$prefix}vals';\n"; //$code .= "\$client->setDebug(\$debug);\n"; return $code; } ?>transport/index.html000066600000000037151375520470010612 0ustar00 transport/.htaccess000066600000000177151375520470010420 0ustar00 Order allow,deny Deny from all klarnacalc.php000066600000051677151375520470007405 0ustar00 * @copyright 2012 Klarna AB (http://klarna.com) * @license http://opensource.org/licenses/BSD-2-Clause BSD-2 * @link http://integration.klarna.com/ */ /** * KlarnaCalc provides methods to calculate part payment functions. * * All rates are yearly rates, but they are calculated monthly. So * a rate of 9 % is used 0.75% monthly. The first is the one we specify * to the customers, and the second one is the one added each month to * the account. The IRR uses the same notation. * * The APR is however calculated by taking the monthly rate and raising * it to the 12 power. This is according to the EU law, and will give * very large numbers if the $pval is small compared to the $fee and * the amount of months you repay is small as well. * * All functions work in discrete mode, and the time interval is the * mythical evenly divided month. There is no way to calculate APR in * days without using integrals and other hairy math. So don't try. * The amount of days between actual purchase and the first bill can * of course vary between 28 and 61 days, but all calculations in this * class assume this time is exactly and that is ok since this will only * overestimate the APR and all examples in EU law uses whole months as well. * * @category Payment * @package KlarnaAPI * @author MS Dev * @copyright 2012 Klarna AB (http://klarna.com) * @license http://opensource.org/licenses/BSD-2-Clause BSD-2 * @link http://integration.klarna.com/ */ class KlarnaCalc { /** * This constant tells the irr function when to stop. * If the calculation error is lower than this the calculation is done. * * @var float */ protected static $accuracy = 0.01; /** * Calculates the midpoint between two points. Used by divide and conquer. * * @param float $a point a * @param float $b point b * * @return float */ private static function _midpoint($a, $b) { return (($a+$b)/2); } /** * npv - Net Present Value * Calculates the difference between the initial loan to the customer * and the individual payments adjusted for the inverse of the interest * rate. The variable we are searching for is $rate and if $pval, * $payarray and $rate is perfectly balanced this function returns 0.0. * * @param float $pval initial loan to customer (in any currency) * @param array $payarray array of monthly payments from the customer * @param float $rate interest rate per year in % * @param int $fromdayone count interest from the first day? yes(1)/no(0) * * @return float */ private static function _npv($pval, $payarray, $rate, $fromdayone) { $month = $fromdayone; foreach ($payarray as $payment) { $pval -= $payment / pow(1 + $rate/(12*100.0), $month++); } return ($pval); } /** * This function uses divide and conquer to numerically find the IRR, * Internal Rate of Return. It starts of by trying a low of 0% and a * high of 100%. If this isn't enough it will double the interval up * to 1000000%. Note that this is insanely high, and if you try to convert * an IRR that high to an APR you will get even more insane values, * so feed this function good data. * * Return values: float irr if it was possible to find a rate that gets * npv closer to 0 than $accuracy. * int -1 The sum of the payarray is less than the lent * amount, $pval. Hellooooooo. Impossible. * int -2 the IRR is way to high, giving up. * * This algorithm works in logarithmic time no matter what inputs you give * and it will come to a good answer within ~30 steps. * * @param float $pval initial loan to customer (in any currency) * @param array $payarray array of monthly payments from the customer * @param int $fromdayone count interest from the first day? yes(1)/no(0) * * @return float */ private static function _irr($pval, $payarray, $fromdayone) { $low = 0.0; $high = 100.0; $lowval = self::_npv($pval, $payarray, $low, $fromdayone); $highval = self::_npv($pval, $payarray, $high, $fromdayone); // The sum of $payarray is smaller than $pval, impossible! if ($lowval > 0.0) { return (-1); } // Standard divide and conquer. do { $mid = self::_midpoint($low, $high); $midval = self::_npv($pval, $payarray, $mid, $fromdayone); if (abs($midval) < self::$accuracy) { //we are close enough return ($mid); } if ($highval < 0.0) { // we are not in range, so double it $low = $high; $lowval = $highval; $high *= 2; $highval = self::_npv($pval, $payarray, $high, $fromdayone); } else if ($midval >= 0.0) { // irr is between low and mid $high = $mid; $highval = $midval; } else { // irr is between mid and high $low = $mid; $lowval = $midval; } } while ($high < 1000000); // bad input, insanely high interest. APR will be INSANER! return (-2); } /** * IRR is not the same thing as APR, Annual Percentage Rate. The * IRR is per time period, i.e. 1 month, and the APR is per year, * and note that that you need to raise to the power of 12, not * mutliply by 12. * * This function turns an IRR into an APR. * * If you feed it a value of 100%, yes the APR will be millions! * If you feed it a value of 9%, it will be 9.3806%. * That is the nature of this math and you can check the wiki * page for APR for more info. * * @param float $irr Internal Rate of Return, expressed yearly, in % * * @return float Annual Percentage Rate, in % */ private static function _irr2apr($irr) { return (100 * (pow(1 + $irr / (12 * 100.0), 12) - 1)); } /** * This is a simplified model of how our paccengine works if * a client always pays their bills. It adds interest and fees * and checks minimum payments. It will run until the value * of the account reaches 0, and return an array of all the * individual payments. Months is the amount of months to run * the simulation. Important! Don't feed it too few months or * the whole loan won't be paid off, but the other functions * should handle this correctly. * * Giving it too many months has no bad effects, or negative * amount of months which means run forever, but it will stop * as soon as the account is paid in full. * * Depending if the account is a base account or not, the * payment has to be 1/24 of the capital amount. * * The payment has to be at least $minpay, unless the capital * amount + interest + fee is less than $minpay; in that case * that amount is paid and the function returns since the client * no longer owes any money. * * @param float $pval initial loan to customer (in any currency) * @param float $rate interest rate per year in % * @param float $fee monthly invoice fee * @param float $minpay minimum monthly payment allowed for this country. * @param float $payment payment the client to pay each month * @param int $months amount of months to run (-1 => infinity) * @param boolean $base is it a base account? * * @return array An array of monthly payments for the customer. */ private static function _fulpacc( $pval, $rate, $fee, $minpay, $payment, $months, $base ) { $bal = $pval; $payarray = array(); while (($months != 0) && ($bal > self::$accuracy)) { $interest = $bal * $rate / (100.0 * 12); $newbal = $bal + $interest + $fee; if ($minpay >= $newbal || $payment >= $newbal) { $payarray[] = $newbal; return $payarray; } $newpay = max($payment, $minpay); if ($base) { $newpay = max($newpay, $bal/24.0 + $fee + $interest); } $bal = $newbal - $newpay; $payarray[] = $newpay; $months -= 1; } return $payarray; } /** * Calculates how much you have to pay each month if you want to * pay exactly the same amount each month. The interesting input * is the amount of $months. * * It does not include the fee so add that later. * * Return value: monthly payment. * * @param float $pval principal value * @param int $months months to pay of in * @param float $rate interest rate in % as before * * @return float monthly payment */ private static function _annuity($pval, $months, $rate) { if ($months == 0) { return $pval; } if ($rate == 0) { return $pval/$months; } $p = $rate / (100.0*12); return $pval * $p / (1 - pow((1+$p), -$months)); } /** * Calculate the APR for an annuity given the following inputs. * * If you give it bad inputs, it will return negative values. * * @param float $pval principal value * @param int $months months to pay off in * @param float $rate interest rate in % as before * @param float $fee monthly fee * @param float $minpay minimum payment per month * * @return float APR in % */ private static function _aprAnnuity($pval, $months, $rate, $fee, $minpay) { $payment = self::_annuity($pval, $months, $rate) + $fee; if ($payment < 0) { return $payment; } $payarray = self::_fulpacc( $pval, $rate, $fee, $minpay, $payment, $months, false ); $apr = self::_irr2apr(self::_irr($pval, $payarray, 1)); return $apr; } /** * Grabs the array of all monthly payments for specified PClass. * * Flags can be either:
* {@link KlarnaFlags::CHECKOUT_PAGE}
* {@link KlarnaFlags::PRODUCT_PAGE}
* * @param float $sum The sum for the order/product. * @param KlarnaPClass $pclass KlarnaPClass used to calculate the APR. * @param int $flags Checkout or Product page. * * @throws KlarnaException * @return array An array of monthly payments. */ private static function _getPayArray($sum, $pclass, $flags) { $monthsfee = 0; if ($flags === KlarnaFlags::CHECKOUT_PAGE) { $monthsfee = $pclass->getInvoiceFee(); } $startfee = 0; if ($flags === KlarnaFlags::CHECKOUT_PAGE) { $startfee = $pclass->getStartFee(); } //Include start fee in sum $sum += $startfee; $base = ($pclass->getType() === KlarnaPClass::ACCOUNT); $lowest = self::get_lowest_payment_for_account($pclass->getCountry()); if ($flags == KlarnaFlags::CHECKOUT_PAGE) { $minpay = ($pclass->getType() === KlarnaPClass::ACCOUNT) ? $lowest : 0; } else { $minpay = 0; } $payment = self::_annuity( $sum, $pclass->getMonths(), $pclass->getInterestRate() ); //Add monthly fee $payment += $monthsfee; return self::_fulpacc( $sum, $pclass->getInterestRate(), $monthsfee, $minpay, $payment, $pclass->getMonths(), $base ); } /** * Calculates APR for the specified values.
* Result is rounded with two decimals.
* * Flags can be either:
* {@link KlarnaFlags::CHECKOUT_PAGE}
* {@link KlarnaFlags::PRODUCT_PAGE}
* * @param float $sum The sum for the order/product. * @param KlarnaPClass $pclass KlarnaPClass used to calculate the APR. * @param int $flags Checkout or Product page. * @param int $free Number of free months. * * @throws KlarnaException * @return float APR in % */ public static function calc_apr($sum, $pclass, $flags, $free = 0) { if (!is_numeric($sum)) { throw new Klarna_InvalidTypeException('sum', 'numeric'); } if (is_numeric($sum) && (!is_int($sum) || !is_float($sum))) { $sum = floatval($sum); } if (!($pclass instanceof KlarnaPClass)) { throw new Klarna_InvalidTypeException('pclass', 'KlarnaPClass'); } if (!is_numeric($free)) { throw new Klarna_InvalidTypeException('free', 'integer'); } if (is_numeric($free) && !is_int($free)) { $free = intval($free); } if ($free < 0) { throw new KlarnaException( 'Error in ' . __METHOD__ . ': Number of free months must be positive or zero!' ); } if (is_numeric($flags) && !is_int($flags)) { $flags = intval($flags); } if (!is_numeric($flags) || !in_array( $flags, array( KlarnaFlags::CHECKOUT_PAGE, KlarnaFlags::PRODUCT_PAGE ) ) ) { throw new Klarna_InvalidTypeException( 'flags', KlarnaFlags::CHECKOUT_PAGE . ' or ' . KlarnaFlags::PRODUCT_PAGE ); } $monthsfee = 0; if ($flags === KlarnaFlags::CHECKOUT_PAGE) { $monthsfee = $pclass->getInvoiceFee(); } $startfee = 0; if ($flags === KlarnaFlags::CHECKOUT_PAGE) { $startfee = $pclass->getStartFee(); } //Include start fee in sum $sum += $startfee; $lowest = self::get_lowest_payment_for_account($pclass->getCountry()); if ($flags == KlarnaFlags::CHECKOUT_PAGE) { $minpay = ($pclass->getType() === KlarnaPClass::ACCOUNT) ? $lowest : 0; } else { $minpay = 0; } //add monthly fee $payment = self::_annuity( $sum, $pclass->getMonths(), $pclass->getInterestRate() ) + $monthsfee; $type = $pclass->getType(); switch($type) { case KlarnaPClass::CAMPAIGN: case KlarnaPClass::ACCOUNT: return round( self::_aprAnnuity( $sum, $pclass->getMonths(), $pclass->getInterestRate(), $pclass->getInvoiceFee(), $minpay ), 2 ); case KlarnaPClass::SPECIAL: throw new Klarna_PClassException( 'Method is not available for SPECIAL pclasses' ); case KlarnaPClass::FIXED: throw new Klarna_PClassException( 'Method is not available for FIXED pclasses' ); default: throw new Klarna_PClassException( 'Unknown PClass type! ('.$type.')' ); } } /** * Calculates the total credit purchase cost.
* The result is rounded up, depending on the pclass country.
* * Flags can be either:
* {@link KlarnaFlags::CHECKOUT_PAGE}
* {@link KlarnaFlags::PRODUCT_PAGE}
* * @param float $sum The sum for the order/product. * @param KlarnaPClass $pclass PClass used to calculate total credit cost. * @param int $flags Checkout or Product page. * * @throws KlarnaException * @return float Total credit purchase cost. */ public static function total_credit_purchase_cost($sum, $pclass, $flags) { if (!is_numeric($sum)) { throw new Klarna_InvalidTypeException('sum', 'numeric'); } if (is_numeric($sum) && (!is_int($sum) || !is_float($sum))) { $sum = floatval($sum); } if (!($pclass instanceof KlarnaPClass)) { throw new Klarna_InvalidTypeException('pclass', 'KlarnaPClass'); } if (is_numeric($flags) && !is_int($flags)) { $flags = intval($flags); } if (!is_numeric($flags) || !in_array( $flags, array( KlarnaFlags::CHECKOUT_PAGE, KlarnaFlags::PRODUCT_PAGE ) ) ) { throw new Klarna_InvalidTypeException( 'flags', KlarnaFlags::CHECKOUT_PAGE . ' or ' . KlarnaFlags::PRODUCT_PAGE ); } $payarr = self::_getPayArray($sum, $pclass, $flags); $credit_cost = 0; foreach ($payarr as $pay) { $credit_cost += $pay; } return self::pRound($credit_cost, $pclass->getCountry()); } /** * Calculates the monthly cost for the specified pclass. * The result is rounded up to the correct value depending on the * pclass country.
* * Example:
*
    *
  • In product view, round monthly cost with max 0.5 or 0.1 * depending on currency.
    *
      *
    • 10.50 SEK rounds to 11 SEK
    • *
    • 10.49 SEK rounds to 10 SEK
    • *
    • 8.55 EUR rounds to 8.6 EUR
    • *
    • 8.54 EUR rounds to 8.5 EUR
    • *
  • *
  • * In checkout, round the monthly cost to have 2 decimals.
    * For example 10.57 SEK/per månad *
  • *
* * Flags can be either:
* {@link KlarnaFlags::CHECKOUT_PAGE}
* {@link KlarnaFlags::PRODUCT_PAGE}
* * @param int $sum The sum for the order/product. * @param KlarnaPClass $pclass PClass used to calculate monthly cost. * @param int $flags Checkout or product page. * * @throws KlarnaException * @return float The monthly cost. */ public static function calc_monthly_cost($sum, $pclass, $flags) { if (!is_numeric($sum)) { throw new Klarna_InvalidTypeException('sum', 'numeric'); } if (is_numeric($sum) && (!is_int($sum) || !is_float($sum))) { $sum = floatval($sum); } if (!($pclass instanceof KlarnaPClass)) { throw new Klarna_InvalidTypeException('pclass', 'KlarnaPClass'); } if (is_numeric($flags) && !is_int($flags)) { $flags = intval($flags); } if (!is_numeric($flags) || !in_array( $flags, array( KlarnaFlags::CHECKOUT_PAGE, KlarnaFlags::PRODUCT_PAGE ) ) ) { throw new Klarna_InvalidTypeException( 'flags', KlarnaFlags::CHECKOUT_PAGE . ' or ' . KlarnaFlags::PRODUCT_PAGE ); } $payarr = self::_getPayArray($sum, $pclass, $flags); $value = 0; if (isset($payarr[0])) { $value = $payarr[0]; } if (KlarnaFlags::CHECKOUT_PAGE == $flags) { return round($value, 2); } return self::pRound($value, $pclass->getCountry()); } /** * Returns the lowest monthly payment for Klarna Account. * * @param int $country KlarnaCountry constant. * * @throws KlarnaException * @return int|float Lowest monthly payment. */ public static function get_lowest_payment_for_account($country) { $country = KlarnaCountry::getCode($country); switch (strtoupper($country)) { case "SE": return 50.0; case "NO": return 95.0; case "FI": return 8.95; case "DK": return 89.0; case "DE": case "AT": return 6.95; case "NL": return 5.0; default: throw new KlarnaException("Invalid country {$country}"); } } /** * Rounds a value depending on the specified country. * * @param int|float $value The value to be rounded. * @param int $country KlarnaCountry constant. * * @return float|int */ public static function pRound($value, $country) { $multiply = 1; //Round to closest integer $country = KlarnaCountry::getCode($country); switch($country) { case "FI": case "DE": case "NL": case "AT": $multiply = 10; //Round to closest decimal break; } return floor(($value*$multiply)+0.5)/$multiply; } } index.html000066600000000057151375520470006560 0ustar00 pclasses/storage.intf.php000066600000014166151375520470011522 0ustar00 * @copyright 2012 Klarna AB (http://klarna.com) * @license http://opensource.org/licenses/BSD-2-Clause BSD-2 * @link http://integration.klarna.com/ */ /** * KlarnaPClass Storage interface * * This class provides an interface with which to save the PClasses easily. * * @category Payment * @package KlarnaAPI * @author MS Dev * @copyright 2012 Klarna AB (http://klarna.com) * @license http://opensource.org/licenses/BSD-2-Clause BSD-2 * @link http://integration.klarna.com/ */ abstract class PCStorage { /** * An array of KlarnaPClasses. * * @var array */ protected $pclasses; /** * Thhe name of the implementation. * The file should be storage.class.php * * @return string */ abstract public function getName(); /** * Adds a PClass to the storage. * * @param KlarnaPClass $pclass PClass object. * * @throws KlarnaException * @return void */ public function addPClass($pclass) { if (! $pclass instanceof KlarnaPClass) { throw new Klarna_InvalidTypeException('pclass', 'KlarnaPClass'); } if (!isset($this->pclasses) || !is_array($this->pclasses)) { $this->pclasses = array(); } if ($pclass->getDescription() === null || $pclass->getType() === null) { //Something went wrong, do not save these! return; } if (!isset($this->pclasses[$pclass->getEid()])) { $this->pclasses[$pclass->getEid()] = array(); } $this->pclasses[$pclass->getEid()][$pclass->getId()] = $pclass; } /** * Gets the PClass by ID. * * @param int $id PClass ID. * @param int $eid Merchant ID. * @param int $country {@link KlarnaCountry Country} constant. * * @throws KlarnaException * @return KlarnaPClass */ public function getPClass($id, $eid, $country) { if (!is_int($id)) { throw new InvalidArgumentException('Supplied ID is not an integer!'); } if (!is_array($this->pclasses)) { throw new Klarna_PClassException('No match for that eid!'); } if (!isset($this->pclasses[$eid]) || !is_array($this->pclasses[$eid])) { throw new Klarna_PClassException('No match for that eid!'); } if (!isset($this->pclasses[$eid][$id]) || !$this->pclasses[$eid][$id]->isValid() ) { throw new Klarna_PClassException('No such pclass available!'); } if ($this->pclasses[$eid][$id]->getCountry() !== $country) { throw new Klarna_PClassException( 'You cannot use this pclass with set country!' ); } return $this->pclasses[$eid][$id]; } /** * Returns an array of KlarnaPClasses, keyed with pclass ID. * If type is specified, only that type will be returned. * * Types available:
* {@link KlarnaPClass::ACCOUNT}
* {@link KlarnaPClass::CAMPAIGN}
* {@link KlarnaPClass::SPECIAL}
* {@link KlarnaPClass::DELAY}
* {@link KlarnaPClass::MOBILE}
* * @param int $eid Merchant ID. * @param int $country {@link KlarnaCountry Country} constant. * @param int $type PClass type identifier. * * @throws KlarnaException * @return array An array of {@link KlarnaPClass PClasses}. */ public function getPClasses($eid, $country, $type = null) { if (!is_int($country)) { throw new Klarna_ArgumentNotSetException('country'); } $tmp = false; if (!is_array($this->pclasses)) { return; } $tmp = array(); foreach ($this->pclasses as $eid => $pclasses) { $tmp[$eid] = array(); foreach ($pclasses as $pclass) { if (!$pclass->isValid()) { continue; //Pclass invalid, skip it. } if ($pclass->getEid() === $eid && $pclass->getCountry() === $country && ($pclass->getType() === $type || $type === null) ) { $tmp[$eid][$pclass->getId()] = $pclass; } } } return $tmp; } /** * Returns a flattened array of all pclasses * * @return array */ public function getAllPClasses() { if (!is_array($this->pclasses)) { return array(); } return $this->_flatten(array_values($this->pclasses)); } /** * Flatten an array * * @param array $array array to flatten * * @return array */ private function _flatten($array) { if (!is_array($array)) { // nothing to do if it's not an array return array($array); } $result = array(); foreach ($array as $value) { // explode the sub-array, and add the parts $result = array_merge($result, $this->_flatten($value)); } return $result; } /** * Loads the PClasses and calls {@link self::addPClass()} to store them * in runtime. * URI can be location to a file, or a db prefixed table. * * @param string $uri URI to stored PClasses. * * @throws KlarnaException|Exception * @return void */ abstract public function load($uri); /** * Takes the internal PClass array and stores it. * URI can be location to a file, or a db prefixed table. * * @param string $uri URI to stored PClasses. * * @throws KlarnaException|Exception * @return void */ abstract public function save($uri); /** * Removes the internally stored pclasses. * * @param string $uri URI to stored PClasses. * * @throws KlarnaException|Exception * @return void */ abstract public function clear($uri); } pclasses/index.html000066600000000057151375520470010375 0ustar00 pclasses/xmlstorage.class.php000066600000017070151375520470012405 0ustar00 * @copyright 2012 Klarna AB (http://klarna.com) * @license http://opensource.org/licenses/BSD-2-Clause BSD-2 * @link http://integration.klarna.com/ */ /** * Include the {@link PCStorage} interface. */ require_once 'storage.intf.php'; /** * XML storage class for KlarnaPClass * * This class is an XML implementation of the PCStorage interface. * * @category Payment * @package KlarnaAPI * @author MS Dev * @copyright 2012 Klarna AB (http://klarna.com) * @license http://opensource.org/licenses/BSD-2-Clause BSD-2 * @link http://integration.klarna.com/ */ class XMLStorage extends PCStorage { /** * The internal XML document. * * @var DOMDocument */ protected $dom; /** * XML version for the DOM document. * * @var string */ protected $version = '1.0'; /** * Encoding for the DOM document. * * @var string */ protected $encoding = 'ISO-8859-1'; /** * Class constructor */ public function __construct() { $this->dom = new DOMDocument($this->version, $this->encoding); $this->dom->formatOutput = true; $this->dom->preserveWhiteSpace = false; } /** * return the name of the storage type * * @return string */ public function getName() { return "xml"; } /** * Checks if the file is writeable, readable or if the directory is. * * @param string $xmlFile URI to XML file. * * @throws KlarnaException * @return void */ protected function checkURI($xmlFile) { //If file doesn't exist, check the directory. if (!file_exists($xmlFile)) { $xmlFile = dirname($xmlFile); } if (!is_writable($xmlFile)) { throw new Klarna_FileNotWritableException($xmlFile); } if (!is_readable($xmlFile)) { throw new Klarna_FileNotReadableException($xmlFile); } } /** * Load pclasses from file * * @param string $uri uri to file to load * * @throws KlarnaException * @return void */ public function load($uri) { $this->checkURI($uri); if (!file_exists($uri)) { //Do not fail, if file doesn't exist. return; } if (!@$this->dom->load($uri)) { throw new Klarna_XMLParseException($uri); } $xpath = new DOMXpath($this->dom); foreach ($xpath->query('/klarna/estore') as $estore) { $eid = $estore->getAttribute('id'); foreach ($xpath->query('pclass', $estore) as $node) { $pclass = new KlarnaPClass(); $pclass->setId( $node->getAttribute('pid') ); $pclass->setType( $node->getAttribute('type') ); $pclass->setEid($eid); $pclass->setDescription( $xpath->query('description', $node)->item(0)->textContent ); $pclass->setMonths( $xpath->query('months', $node)->item(0)->textContent ); $pclass->setStartFee( $xpath->query('startfee', $node)->item(0)->textContent ); $pclass->setInvoiceFee( $xpath->query('invoicefee', $node)->item(0)->textContent ); $pclass->setInterestRate( $xpath->query('interestrate', $node)->item(0)->textContent ); $pclass->setMinAmount( $xpath->query('minamount', $node)->item(0)->textContent ); $pclass->setCountry( $xpath->query('country', $node)->item(0)->textContent ); $pclass->setExpire( $xpath->query('expire', $node)->item(0)->textContent ); $this->addPClass($pclass); } } } /** * Creates DOMElement for all fields for specified PClass. * * @param KlarnaPClass $pclass pclass object * * @return array Array of DOMElements. */ protected function createFields($pclass) { $fields = array(); //This is to prevent HTMLEntities to be converted to the real character. $fields[] = $this->dom->createElement('description'); end($fields)->appendChild( $this->dom->createTextNode($pclass->getDescription()) ); $fields[] = $this->dom->createElement( 'months', $pclass->getMonths() ); $fields[] = $this->dom->createElement( 'startfee', $pclass->getStartFee() ); $fields[] = $this->dom->createElement( 'invoicefee', $pclass->getInvoiceFee() ); $fields[] = $this->dom->createElement( 'interestrate', $pclass->getInterestRate() ); $fields[] = $this->dom->createElement( 'minamount', $pclass->getMinAmount() ); $fields[] = $this->dom->createElement( 'country', $pclass->getCountry() ); $fields[] = $this->dom->createElement( 'expire', $pclass->getExpire() ); return $fields; } /** * Save pclasses to file * * @param string $uri uri to file to save * * @throws KlarnaException * @return void */ public function save($uri) { $this->checkURI($uri); //Reset DOMDocument. if (!$this->dom->loadXML( "version' encoding='$this->encoding'?" .">" ) ) { throw new Klarna_XMLParseException($uri); } ksort($this->pclasses, SORT_NUMERIC); $xpath = new DOMXpath($this->dom); foreach ($this->pclasses as $eid => $pclasses) { $estore = $xpath->query('/klarna/estore[@id="'.$eid.'"]'); if ($estore === false || $estore->length === 0) { //No estore with matching eid, create it. $estore = $this->dom->createElement('estore'); $estore->setAttribute('id', $eid); $this->dom->documentElement->appendChild($estore); } else { $estore = $estore->item(0); } foreach ($pclasses as $pclass) { if ($eid != $pclass->getEid()) { //This should never occur, failsafe. continue; } $pnode = $this->dom->createElement('pclass'); foreach ($this->createFields($pclass) as $field) { $pnode->appendChild($field); } $pnode->setAttribute('pid', $pclass->getId()); $pnode->setAttribute('type', $pclass->getType()); $estore->appendChild($pnode); } } if (!$this->dom->save($uri)) { throw new KlarnaException('Failed to save XML document!'); } } /** * This uses unlink (delete) to clear the pclasses! * * @param string $uri uri to file to clear * * @throws KlarnaException * @return void */ public function clear($uri) { $this->checkURI($uri); unset($this->pclasses); if (file_exists($uri)) { unlink($uri); } } } pclasses/jsonstorage.class.php000066600000006760151375520470012562 0ustar00 * @copyright 2012 Klarna AB (http://klarna.com) * @license http://opensource.org/licenses/BSD-2-Clause BSD-2 * @link http://integration.klarna.com/ */ /** * Include the {@link PCStorage} interface. */ require_once 'storage.intf.php'; /** * JSON storage class for KlarnaPClass * * This class is an JSON implementation of the PCStorage interface. * * @category Payment * @package KlarnaAPI * @author MS Dev * @copyright 2012 Klarna AB (http://klarna.com) * @license http://opensource.org/licenses/BSD-2-Clause BSD-2 * @link http://integration.klarna.com/ */ class JSONStorage extends PCStorage { /** * return the name of the storage type * * @return string */ public function getName() { return "json"; } /** * Checks if the file is writeable, readable or if the directory is. * * @param string $jsonFile json file that holds the pclasses * * @throws error * @return void */ protected function checkURI($jsonFile) { //If file doesn't exist, check the directory. if (!file_exists($jsonFile)) { $jsonFile = dirname($jsonFile); } if (!is_writable($jsonFile)) { throw new Klarna_FileNotWritableException($jsonFile); } if (!is_readable($jsonFile)) { throw new Klarna_FileNotReadableException($jsonFile); } } /** * Clear the pclasses * * @param string $uri uri to file to clear * * @throws KlarnaException * @return void */ public function clear($uri) { $this->checkURI($uri); unset($this->pclasses); if (file_exists($uri)) { unlink($uri); } } /** * Load pclasses from file * * @param string $uri uri to file to load * * @throws KlarnaException * @return void */ public function load($uri) { $this->checkURI($uri); if (!file_exists($uri)) { //Do not fail, if file doesn't exist. return; } $arr = json_decode(file_get_contents($uri), true); if (count($arr) == 0) { return; } foreach ($arr as $pclasses) { if (count($pclasses) == 0) { continue; } foreach ($pclasses as $pclass) { $this->addPClass(new KlarnaPClass($pclass)); } } } /** * Save pclasses to file * * @param string $uri uri to file to save * * @throws KlarnaException * @return void */ public function save($uri) { try { $this->checkURI($uri); $output = array(); foreach ($this->pclasses as $eid => $pclasses) { foreach ($pclasses as $pclass) { if (!isset($output[$eid])) { $output[$eid] = array(); } $output[$eid][] = $pclass->toArray(); } } if (count($this->pclasses) > 0) { file_put_contents($uri, json_encode($output)); } else { file_put_contents($uri, ""); } } catch(Exception $e) { throw new KlarnaException($e->getMessage()); } } } pclasses/sqlstorage.class.php000066600000031244151375520470012403 0ustar00 * @copyright 2012 Klarna AB (http://klarna.com) * @license http://opensource.org/licenses/BSD-2-Clause BSD-2 * @link http://integration.klarna.com/ */ /** * Include the {@link PCStorage} interface. */ require_once 'storage.intf.php'; /** * SQL storage class for KlarnaPClass * * This class is an MySQL implementation of the PCStorage interface.
* Config field pcURI needs to match format: * user:passwd@addr:port/dbName.dbTable
* Port can be omitted.
* * Acceptable characters:
* Username: [A-Za-z0-9_]
* Password: [A-Za-z0-9_]
* Address: [A-Za-z0-9_.]
* Port: [0-9]
* DB name: [A-Za-z0-9_]
* DB table: [A-Za-z0-9_]
* * To allow for more special characters, and to avoid having
* a regular expression that is too hard to understand, you can
* use an associative array:
* * array( * "user" => "myuser", * "passwd" => "mypass", * "dsn" => "localhost", * "db" => "mydatabase", * "table" => "mytable" * ); * * * @category Payment * @package KlarnaAPI * @author MS Dev * @copyright 2012 Klarna AB (http://klarna.com) * @license http://opensource.org/licenses/BSD-2-Clause BSD-2 * @link http://integration.klarna.com/ */ class SQLStorage extends PCStorage { /** * Database name. * * @var string */ protected $dbName; /** * Database table. * * @var string */ protected $dbTable; /** * Database address. * * @var string */ protected $addr; /** * PDO DSN notation. * * @var string */ protected $dsn; /** * Database username. * * @var string */ protected $user; /** * Database password. * * @var string */ protected $passwd; /** * PDO DB link resource. * * @var PDO */ protected $pdo; /** * return the name of the storage type * * @return string */ public function getName() { return "sql"; } /** * Splits the URI for the following formats:
* user:passwd@addr/dbName.dbTable (assumes MySQL)
* user:password@pdo:dsn/dbName.dbTable
* * To allow for more special characters, and to avoid having
* a regular expression that is too hard to understand, you can
* use an associative array:
* * array( * "user" => "myuser", * "passwd" => "mypass", * "dsn" => "localhost", * "db" => "mydatabase", * "table" => "mytable" * ); * * * @param string|array $uri Specified URI to database and table. * * @throws KlarnaException * @return void */ protected function splitURI($uri) { /* If you want to have some characters that would make the regexp too complex, you can use an array as input instead. */ if (is_array($uri)) { $this->user = $uri['user']; $this->passwd = $uri['passwd']; $this->dsn = $uri['dsn']; $this->dbName = $uri['db']; $this->dbTable = $uri['table']; return array( $uri, $this->user, $this->passwd, $this->dsn, $this->dbName, $this->dbTable ); } $pdo_rex = '/^([\w-]+):([\w-]+)@pdo:([\w.,:;\/ \\\t=\(\){}\*-]+)\/([\w-]+)'. '.([\w-]+)$/'; $pcuri_rex = '/^([\w-]+):([\w-]+)@([\w\.-]+|[\w\.-]+:[\d]+|[\w\.-]+:'. '[\w\.\/-]+|:[\w\.\/-]+)\/([\w-]+).([\w-]+)$/'; $arr = null; if (preg_match($pdo_rex, $uri, $arr) === 1) { /* * [0] => user:password@pdo:dsn/dbName.dbTable * [1] => user * [2] => passwd * [3] => dsn * [4] => dbName * [5] => dbTable */ if (count($arr) != 6) { throw new Klarna_DatabaseException( 'URI is invalid! Missing field or invalid characters used!' ); } $this->user = $arr[1]; $this->passwd = $arr[2]; $this->dsn = $arr[3]; $this->dbName = $arr[4]; $this->dbTable = $arr[5]; } else if (preg_match($pcuri_rex, $uri, $arr) === 1) { //user:pass@127.0.0.1:3306/dbName.dbTable //user:pass@localhost:/tmp/mysql.sock/dbName.dbTable /* * [0] => user:passwd@addr/dbName.dbTable * [1] => user * [2] => passwd * [3] => addr * [4] => dbName * [5] => dbTable */ if (count($arr) != 6) { throw new Klarna_DatabaseException( 'URI is invalid! Missing field or invalid characters used!' ); } $this->user = $arr[1]; $this->passwd = $arr[2]; $this->addr = $arr[3]; $this->port = 3306; if (preg_match( '/^([0-9.]+(:([0-9]+))?)$/', $this->addr, $tmp ) === 1 ) { if (isset($tmp[3])) { $this->port = $tmp[3]; } } $this->dbName = $arr[4]; $this->dbTable = $arr[5]; $this->dsn = "mysql:host={$this->addr};port={$this->port};"; } else { throw new Klarna_DatabaseException( 'URI to SQL is not valid! ( user:passwd@addr/dbName.dbTable )' ); } return $arr; } /** * Grabs the PDO connection to the database, specified by the URI. * * @param string $uri pclass uri * * @return void * @throws KlarnaException */ protected function getConnection($uri) { if ($this->pdo) { return; //Already have a connection } $this->splitURI($uri); try { $this->pdo = new PDO($this->dsn, $this->user, $this->passwd); $this->pdo->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION); } catch (PDOException $e) { throw new Klarna_DatabaseException('Failed to connect to database!'); } } /** * Initializes the DB, if the database or table is missing. * * @return void * @throws KlarnaException */ protected function initDB() { try { $this->pdo->exec("CREATE DATABASE `{$this->dbName}`"); } catch (PDOException $e) { //SQLite does not support this... //throw new KlarnaException( // 'Database non-existant, failed to create it!' //); } $sql = <<dbName}`.`{$this->dbTable}` ( `eid` int(10) NOT NULL, `id` int(10) NOT NULL, `type` int(4) NOT NULL, `description` varchar(255) NOT NULL, `months` int(11) NOT NULL, `interestrate` decimal(11,2) NOT NULL, `invoicefee` decimal(11,2) NOT NULL, `startfee` decimal(11,2) NOT NULL, `minamount` decimal(11,2) NOT NULL, `country` int(11) NOT NULL, `expire` int(11) NOT NULL ); SQL; try { $this->pdo->exec($sql); } catch (PDOException $e) { throw new Klarna_DatabaseException( 'Table non-existant, failed to create it!' ); } } /** * Connects to the DB and checks if DB and table exists. * * @param string|array $uri pclass uri * * @throws KlarnaException * @return void */ protected function connect($uri) { $this->getConnection($uri); $this->initDB(); } /** * Loads the PClasses. * * @param string|array $uri pclass uri * * @return void * @throws KlarnaException */ public function load($uri) { $this->connect($uri); $this->loadPClasses(); } /** * Loads the PClasses. * * @return void * @throws KlarnaException */ protected function loadPClasses() { try { $sth = $this->pdo->prepare( "SELECT * FROM `{$this->dbName}`.`{$this->dbTable}`", array(PDO::ATTR_CURSOR => PDO::CURSOR_FWDONLY) ); $sth->execute(); while ($row = $sth->fetch(PDO::FETCH_ASSOC, PDO::FETCH_ORI_NEXT)) { $this->addPClass(new KlarnaPClass($row)); } $sth->closeCursor(); $sth = null; } catch (PDOException $e) { throw new Klarna_DatabaseException( 'Could not fetch PClasses from database!' ); } } /** * Saves the PClasses. * * @param string|array $uri pclass uri * * @return void * @throws KlarnaException */ public function save($uri) { $this->connect($uri); //Only attempt to savePClasses if there are any. if (!is_array($this->pclasses)) { return; } if (count($this->pclasses) == 0) { return; } $this->savePClasses(); } /** * Saves the PClasses. * * @return void * @throws KlarnaException */ protected function savePClasses() { //Insert PClass SQL statement. $sql = <<dbName}`.`{$this->dbTable}` (`eid`, `id`, `type`, `description`, `months`, `interestrate`, `invoicefee`, `startfee`, `minamount`, `country`, `expire`) VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?) SQL; foreach ($this->pclasses as $pclasses) { foreach ($pclasses as $pclass) { try { //Remove the pclass if it exists. $sth = $this->pdo->prepare( "DELETE FROM `{$this->dbName}`.`{$this->dbTable}` WHERE `id` = ? AND `eid` = ?" ); $sth->execute( array( $pclass->getId(), $pclass->getEid() ) ); $sth->closeCursor(); $sth = null; } catch(PDOException $e) { //Fail silently, we don't care if the removal failed. } try { //Attempt to insert the PClass into the DB. $sth = $this->pdo->prepare($sql); $sth->execute( array( $pclass->getEid(), $pclass->getId(), $pclass->getType(), $pclass->getDescription(), $pclass->getMonths(), $pclass->getInterestRate(), $pclass->getInvoiceFee(), $pclass->getStartFee(), $pclass->getMinAmount(), $pclass->getCountry(), $pclass->getExpire() ) ); $sth->closeCursor(); $sth = null; } catch(PDOException $e) { throw new Klarna_DatabaseException( 'Failed to insert PClass into database!' ); } } } } /** * Drops the database table, to clear the PClasses. * * @param string|array $uri pclass uri * * @return void * @throws KlarnaException */ public function clear($uri) { try { $this->connect($uri); unset($this->pclasses); $this->clearTable(); } catch(Exception $e) { throw new Klarna_DatabaseException( $e->getMessage(), $e->getCode() ); } } /** * Drops the database table, to clear the PClasses. * * @return void * @throws KlarnaException */ protected function clearTable() { try { $this->pdo->exec("DELETE FROM `{$this->dbName}`.`{$this->dbTable}`"); } catch (PDOException $e) { throw new Klarna_DatabaseException('Could not clear the database!'); } } } pclasses/mysqlstorage.class.php000066600000021520151375520470012745 0ustar00 * @copyright 2012 Klarna AB (http://klarna.com) * @license http://opensource.org/licenses/BSD-2-Clause BSD-2 * @link http://integration.klarna.com/ */ /** * Include the {@link PCStorage} interface. */ require_once 'storage.intf.php'; /** * MySQL storage class for KlarnaPClass * * This class is an MySQL implementation of the PCStorage interface.
* Config field pcURI needs to match format: * user:passwd@addr:port/dbName.dbTable
* Port can be omitted.
* * Acceptable characters:
* Username: [A-Za-z0-9_]
* Password: [A-Za-z0-9_]
* Address: [A-Za-z0-9_.]
* Port: [0-9]
* DB name: [A-Za-z0-9_]
* DB table: [A-Za-z0-9_]
* * To allow for more special characters, and to avoid having
* a regular expression that is too hard to understand, you can
* use an associative array:
* * array( * "user" => "myuser", * "passwd" => "mypass", * "dsn" => "localhost", * "db" => "mydatabase", * "table" => "mytable" * ); * * * @category Payment * @package KlarnaAPI * @author MS Dev * @copyright 2012 Klarna AB (http://klarna.com) * @license http://opensource.org/licenses/BSD-2-Clause BSD-2 * @link http://integration.klarna.com/ */ class MySQLStorage extends PCStorage { /** * Database name. * * @var string */ protected $dbName; /** * Database table. * * @var string */ protected $dbTable; /** * Database address. * * @var string */ protected $addr; /** * Database username. * * @var string */ protected $user; /** * Database password. * * @var string */ protected $passwd; /** * MySQL DB link resource. * * @var resource */ protected $link; /** * return the name of the storage type * * @return string */ public function getName() { return "mysql"; } /** * Connects to the DB and checks if DB and table exists. * * @throws KlarnaException * @return void */ protected function connect() { $this->link = mysql_connect($this->addr, $this->user, $this->passwd); if ($this->link === false) { throw new Klarna_DatabaseException( 'Failed to connect to database! ('.mysql_error().')' ); } if (!mysql_query( "CREATE DATABASE IF NOT EXISTS `{$this->dbName}`", $this->link ) ) { throw new Klarna_DatabaseException( 'Failed to create! ('.mysql_error().')' ); } $create = mysql_query( "CREATE TABLE IF NOT EXISTS `{$this->dbName}`.`{$this->dbTable}` ( `eid` int(10) unsigned NOT NULL, `id` int(10) unsigned NOT NULL, `type` tinyint(4) NOT NULL, `description` varchar(255) NOT NULL, `months` int(11) NOT NULL, `interestrate` decimal(11,2) NOT NULL, `invoicefee` decimal(11,2) NOT NULL, `startfee` decimal(11,2) NOT NULL, `minamount` decimal(11,2) NOT NULL, `country` int(11) NOT NULL, `expire` int(11) NOT NULL, KEY `id` (`id`) )", $this->link ); if (!$create) { throw new Klarna_DatabaseException( 'Table not existing, failed to create! ('.mysql_error().')' ); } } /** * Splits the URI in format: user:passwd@addr/dbName.dbTable
* * To allow for more special characters, and to avoid having
* a regular expression that is too hard to understand, you can
* use an associative array:
* * array( * "user" => "myuser", * "passwd" => "mypass", * "dsn" => "localhost", * "db" => "mydatabase", * "table" => "mytable" * ); * * * @param string|array $uri Specified URI to database and table. * * @throws KlarnaException * @return void */ protected function splitURI($uri) { if (is_array($uri)) { $this->user = $uri['user']; $this->passwd = $uri['passwd']; $this->addr = $uri['dsn']; $this->dbName = $uri['db']; $this->dbTable = $uri['table']; } else if (preg_match( '/^([\w-]+):([\w-]+)@([\w\.-]+|[\w\.-]+:[\d]+)\/([\w-]+).([\w-]+)$/', $uri, $arr ) === 1 ) { /* [0] => user:passwd@addr/dbName.dbTable [1] => user [2] => passwd [3] => addr [4] => dbName [5] => dbTable */ if (count($arr) != 6) { throw new Klarna_DatabaseException( 'URI is invalid! Missing field or invalid characters used!' ); } $this->user = $arr[1]; $this->passwd = $arr[2]; $this->addr = $arr[3]; $this->dbName = $arr[4]; $this->dbTable = $arr[5]; } else { throw new Klarna_DatabaseException( 'URI to MySQL is not valid! ( user:passwd@addr/dbName.dbTable )' ); } } /** * Load pclasses * * @param string $uri pclass uri * * @throws KlarnaException * @return void */ public function load($uri) { $this->splitURI($uri); $this->connect(); $result = mysql_query( "SELECT * FROM `{$this->dbName}`.`{$this->dbTable}`", $this->link ); if ($result === false) { throw new Klarna_DatabaseException( 'SELECT query failed! ('.mysql_error().')' ); } while ($row = mysql_fetch_assoc($result)) { $this->addPClass(new KlarnaPClass($row)); } } /** * Save pclasses to database * * @param string $uri pclass uri * * @throws KlarnaException * @return void */ public function save($uri) { $this->splitURI($uri); $this->connect(); if (!is_array($this->pclasses) || count($this->pclasses) == 0) { return; } foreach ($this->pclasses as $pclasses) { foreach ($pclasses as $pclass) { //Remove the pclass if it exists. mysql_query( "DELETE FROM `{$this->dbName}`.`{$this->dbTable}` WHERE `id` = '{$pclass->getId()}' AND `eid` = '{$pclass->getEid()}'" ); //Insert it again. $result = mysql_query( "INSERT INTO `{$this->dbName}`.`{$this->dbTable}` (`eid`, `id`, `type`, `description`, `months`, `interestrate`, `invoicefee`, `startfee`, `minamount`, `country`, `expire` ) VALUES ('{$pclass->getEid()}', '{$pclass->getId()}', '{$pclass->getType()}', '{$pclass->getDescription()}', '{$pclass->getMonths()}', '{$pclass->getInterestRate()}', '{$pclass->getInvoiceFee()}', '{$pclass->getStartFee()}', '{$pclass->getMinAmount()}', '{$pclass->getCountry()}', '{$pclass->getExpire()}')", $this->link ); if ($result === false) { throw new Klarna_DatabaseException( 'INSERT INTO query failed! ('.mysql_error().')' ); } } } } /** * Clear the pclasses * * @param string $uri pclass uri * * @throws KlarnaException * @return void */ public function clear($uri) { try { $this->splitURI($uri); unset($this->pclasses); $this->connect(); mysql_query( "DELETE FROM `{$this->dbName}`.`{$this->dbTable}`", $this->link ); } catch(Exception $e) { throw new Klarna_DatabaseException( $e->getMessage(), $e->getCode() ); } } } pclasses/.htaccess000066600000000177151375520470010201 0ustar00 Order allow,deny Deny from all klarnaconfig.php000066600000010361151375520470007731 0ustar00 * @copyright 2012 Klarna AB (http://klarna.com) * @license http://opensource.org/licenses/BSD-2-Clause BSD-2 * @link http://integration.klarna.com/ */ /** * Configuration class for the Klarna instance. * * KlarnaConfig stores added fields in JSON, it also prepends.
* Loads/saves specified file, or default file, if {@link KlarnaConfig::$store} * is set to true.
* * You add settings using the ArrayAccess:
* $arr['field'] = $val or $arr->offsetSet('field', $val);
* * Available settings are:
* eid - Merchant ID (int) * secret - Shared secret (string) * country - Country constant or code (int|string) * language - Language constant or code (int|string) * currency - Currency constant or code (int|string) * mode - Klarna::BETA or Klarna::LIVE * ssl - Use HTTPS or HTTP. (bool) * candice - Status reporting to Klarna, to detect erroneous * integrations, etc. (bool) * pcStorage - Storage module, e.g. 'json' * pcURI - URI to where the PClasses are stored, e.g. * '/srv/shop/pclasses.json' * xmlrpcDebug - XMLRPC debugging (bool) * debug - Normal debugging (bool) * * @category Payment * @package KlarnaAPI * @author MS Dev * @copyright 2012 Klarna AB (http://klarna.com) * @license http://opensource.org/licenses/BSD-2-Clause BSD-2 * @link http://integration.klarna.com/ */ class KlarnaConfig implements ArrayAccess { /** * An array containing all the options for this config. * * @ignore Do not show in PHPDoc. * @var array */ protected $options; /** * If set to true, saves the config. * * @var bool */ public static $store = true; /** * URI to the config file. * * @ignore Do not show in PHPDoc. * @var string */ protected $file; /** * Class constructor * * Loads specified file, or default file, * if {@link KlarnaConfig::$store} is set to true. * * @param string $file URI to config file, e.g. ./config.json */ public function __construct($file = null) { $this->options = array(); if ($file) { $this->file = $file; if (is_readable($this->file)) { $this->options = json_decode( file_get_contents( $this->file ), true ); } } } /** * Clears the config. * * @return void */ public function clear() { $this->options = array(); } /** * Class destructor * * Saves specified file, or default file, * if {@link KlarnaConfig::$store} is set to true. */ public function __destruct() { if (self::$store && $this->file) { if ((!file_exists($this->file) && is_writable(dirname($this->file))) || is_writable($this->file) ) { file_put_contents($this->file, json_encode($this->options)); } } } /** * Returns true whether the field exists. * * @param mixed $offset field * * @return bool */ public function offsetExists($offset) { return isset($this->options[$offset]); } /** * Used to get the value of a field. * * @param mixed $offset field * * @return mixed */ public function offsetGet($offset) { if (!$this->offsetExists($offset)) { return null; } return $this->options[$offset]; } /** * Used to set a value to a field. * * @param mixed $offset field * @param mixed $value value * * @return void */ public function offsetSet($offset, $value) { $this->options[$offset] = $value; } /** * Removes the specified field. * * @param mixed $offset field * * @return void */ public function offsetUnset($offset) { unset($this->options[$offset]); } } klarnaaddr.php000066600000027750151375520470007410 0ustar00 * @copyright 2012 Klarna AB (http://klarna.com) * @license http://opensource.org/licenses/BSD-2-Clause BSD-2 * @link http://integration.klarna.com/ */ /** * KlarnaAddr is an object of convenience, to parse and create addresses. * * @category Payment * @package KlarnaAPI * @author MS Dev * @copyright 2012 Klarna AB (http://klarna.com) * @license http://opensource.org/licenses/BSD-2-Clause BSD-2 * @link http://integration.klarna.com/ */ class KlarnaAddr { /** * Email address. * * @var string */ protected $email; /** * Phone number. * * @var string */ protected $telno; /** * Cellphone number. * * @var string */ protected $cellno; /** * First name. * * @var string */ protected $fname; /** * Last name. * * @var string */ protected $lname; /** * Company name. * * @var string */ protected $company; /** * Care of, C/O. * * @var string */ protected $careof; /** * Street address. * * @var string */ protected $street; /** * Zip code. * * @var string */ protected $zip; /** * City. * * @var string */ protected $city; /** * KlarnaCountry constant * * @var int */ protected $country; /** * House number. * Only for NL and DE! * * @var string */ protected $houseNo; /** * House extension. * Only for NL! * * @var string */ protected $houseExt; /** * When using {@link Klarna::getAddresses()} this might be guessed * depending on type used. * * Signifies if address is for a company or a private person. * If isCompany is null, then it is unknown and will be assumed to * be a private person. * * Note:
* This has no effect on transmitted data. * * @var bool|null */ public $isCompany = null; /** * Class constructor. * * Calls the set methods for all arguments. * * @param string $email Email address. * @param string $telno Phone number. * @param string $cellno Cellphone number. * @param string $fname First name. * @param string $lname Last name. * @param string $careof Care of, C/O. * @param string $street Street address. * @param string $zip Zip code. * @param string $city City. * @param string|int $country KlarnaCountry constant or two letter code. * @param string $houseNo House number, only used in DE and NL. * @param string $houseExt House extension, only used in NL. * * @throws KlarnaException */ public function __construct( $email = null, $telno = null, $cellno = null, $fname = null, $lname = null, $careof = "", $street = null, $zip = null, $city = null, $country = null, $houseNo = "", $houseExt = "" ) { //Set all string values to "" $this->company = ""; $this->telno = ""; $this->careof = ""; $this->cellno = ""; $this->city = ""; $this->email = ""; $this->fname = ""; $this->lname = ""; $this->zip = ""; if ($email !== null) { $this->setEmail($email); } if ($telno !== null) { $this->setTelno($telno); } if ($cellno !== null) { $this->setCellno($cellno); } if ($fname !== null) { $this->setFirstName($fname); } if ($lname !== null) { $this->setLastName($lname); } $this->setCareof($careof); if ($street !== null) { $this->setStreet($street); } if ($zip !== null) { $this->setZipCode($zip); } if ($city !== null) { $this->setCity($city); } if ($country !== null) { $this->setCountry($country); } $this->setHouseNumber($houseNo); $this->setHouseExt($houseExt); } /** * Returns the email address. * * @return string */ public function getEmail() { return $this->email; } /** * Sets the email address. * * @param string $email email address * * @return void */ public function setEmail($email) { if (!is_string($email)) { $email = strval($email); } $this->email = $email; } /** * Returns the phone number. * * @return string */ public function getTelno() { return $this->telno; } /** * Sets the phone number. * * @param string $telno telno * * @return void */ public function setTelno($telno) { if (!is_string($telno)) { $telno = strval($telno); } $this->telno = $telno; } /** * Returns the cellphone number. * * @return string */ public function getCellno() { return $this->cellno; } /** * Sets the cellphone number. * * @param string $cellno mobile number * * @return void */ public function setCellno($cellno) { if (!is_string($cellno)) { $cellno = strval($cellno); } $this->cellno = $cellno; } /** * Returns the first name. * * @return string */ public function getFirstName() { return $this->fname; } /** * Sets the first name. * * @param string $fname firstname * * @return void */ public function setFirstName($fname) { if (!is_string($fname)) { $fname = strval($fname); } $this->fname = $fname; } /** * Returns the last name. * * @return string */ public function getLastName() { return $this->lname; } /** * Sets the last name. * * @param string $lname lastname * * @return void */ public function setLastName($lname) { if (!is_string($lname)) { $lname = strval($lname); } $this->lname = $lname; } /** * Returns the company name. * * @return string */ public function getCompanyName() { return $this->company; } /** * Sets the company name. * If the purchase results in a company purchase, * reference person will be used from first and last name, * or the value set with {@link Klarna::setReference()}. * * @param string $company company name * * @see Klarna::setReference * @return void */ public function setCompanyName($company) { if (!is_string($company)) { $company = strval($company); } $this->company = $company; } /** * Returns the care of, C/O. * * @return string */ public function getCareof() { return $this->careof; } /** * Sets the care of, C/O. * * @param string $careof care of address * * @return void */ public function setCareof($careof) { if (!is_string($careof)) { $careof = strval($careof); } $this->careof = $careof; } /** * Returns the street address. * * @return string */ public function getStreet() { return $this->street; } /** * Sets the street address. * * @param string $street street address * * @return void */ public function setStreet($street) { if (!is_string($street)) { $street = strval($street); } $this->street = $street; } /** * Returns the zip code. * * @return string */ public function getZipCode() { return $this->zip; } /** * Sets the zip code. * * @param string $zip zip code * * @return void */ public function setZipCode($zip) { if (!is_string($zip)) { $zip = strval($zip); } $zip = str_replace(' ', '', $zip); //remove spaces $this->zip = $zip; } /** * Returns the city. * * @return string */ public function getCity() { return $this->city; } /** * Sets the city. * * @param string $city city * * @return void */ public function setCity($city) { if (!is_string($city)) { $city = strval($city); } $this->city = $city; } /** * Returns the country as a integer constant. * * @return int {@link KlarnaCountry} */ public function getCountry() { return $this->country; } /** * Returns the country as a two letter representation. * * @throws KlarnaException * @return string E.g. 'de', 'dk', ... */ public function getCountryCode() { return KlarnaCountry::getCode($this->country); } /** * Sets the country, use either a two letter representation or the integer * constant. * * @param int $country {@link KlarnaCountry} * * @throws KlarnaException * @return void */ public function setCountry($country) { if ($country === null) { throw new Klarna_ArgumentNotSetException('Country'); } if (is_numeric($country)) { if (!is_int($country)) { $country = intval($country); } $this->country = $country; return; } if (strlen($country) == 2 || strlen($country) == 3) { $this->setCountry(KlarnaCountry::fromCode($country)); return; } throw new KlarnaException("Failed to set country! ($country)"); } /** * Returns the house number.
* Only used in Germany and Netherlands.
* * @return string */ public function getHouseNumber() { return $this->houseNo; } /** * Sets the house number.
* Only used in Germany and Netherlands.
* * @param string $houseNo house number * * @return void */ public function setHouseNumber($houseNo) { if (!is_string($houseNo)) { $houseNo = strval($houseNo); } $this->houseNo = $houseNo; } /** * Returns the house extension.
* Only used in Netherlands.
* * @return string */ public function getHouseExt() { return $this->houseExt; } /** * Sets the house extension.
* Only used in Netherlands.
* * @param string $houseExt house extension * * @return void */ public function setHouseExt($houseExt) { if (!is_string($houseExt)) { $houseExt = strval($houseExt); } $this->houseExt = $houseExt; } /** * Returns an associative array representing this object. * * @return array */ public function toArray() { return array( 'email' => $this->getEmail(), 'telno' => $this->getTelno(), 'cellno' => $this->getCellno(), 'fname' => $this->getFirstName(), 'lname' => $this->getLastName(), 'company' => $this->getCompanyName(), 'careof' => $this->getCareof(), 'street' => $this->getStreet(), 'house_number' => $this->getHouseNumber(), 'house_extension' => $this->getHouseExt(), 'zip' => $this->getZipCode(), 'city' => $this->getCity(), 'country' => $this->getCountry(), ); } } Country.php000066600000053276151375520470006752 0ustar00 * @copyright 2012 Klarna AB (http://klarna.com) * @license http://opensource.org/licenses/BSD-2-Clause BSD-2 * @link http://integration.klarna.com/ */ /** * Country Constants class * * @category Payment * @package KlarnaAPI * @author MS Dev * @copyright 2012 Klarna AB (http://klarna.com) * @license http://opensource.org/licenses/BSD-2-Clause BSD-2 * @link http://integration.klarna.com/ */ class KlarnaCountry { /** * Country constant for Austria (AT).
* ISO3166_AT * * @var int */ const AT = 15; /** * Country constant for Denmark (DK).
* ISO3166_DK * * @var int */ const DK = 59; /** * Country constant for Finland (FI).
* ISO3166_FI * * @var int */ const FI = 73; /** * Country constant for Germany (DE).
* ISO3166_DE * * @var int */ const DE = 81; /** * Country constant for Netherlands (NL).
* ISO3166_NL * * @var int */ const NL = 154; /** * Country constant for Norway (NO).
* ISO3166_NO * * @var int */ const NO = 164; /** * Country constant for Sweden (SE).
* ISO3166_SE * * @var int */ const SE = 209; /** * Converts a country code, e.g. 'de' or 'deu' to the KlarnaCountry constant. * * @param string $val country code iso-alpha-2 or iso-alpha-3 * * @return int|null */ public static function fromCode($val) { $val = strtoupper($val); if (strlen($val) === 3) { if (self::$_tlcFlip === array()) { self::$_tlcFlip = array_flip(self::$_tlcMap); } if (!array_key_exists($val, self::$_tlcFlip)) { return null; } $val = self::$_tlcFlip[$val]; } if (array_key_exists($val, self::$_countries)) { return self::$_countries[$val]; } return null; } /** * Converts a KlarnaCountry constant to the respective country code. * * @param int $val KlarnaCountry constant * @param bool $alpha3 Whether to return a ISO-3166-1 alpha-3 code * * @return string|null */ public static function getCode($val, $alpha3 = false) { if (self::$_countryFlip === array()) { self::$_countryFlip = array_flip(self::$_countries); } if (!array_key_exists($val, self::$_countryFlip)) { return null; } $result = self::$_countryFlip[$val]; if ($alpha3) { return self::$_tlcMap[$result]; } return $result; } /** * Checks country against currency and returns true if they match. * * @param int $country {@link KlarnaCountry} * @param int $language {@link KlarnaLanguage} * * @deprecated Do not use. * * @return bool */ public static function checkLanguage($country, $language) { switch($country) { case KlarnaCountry::AT: case KlarnaCountry::DE: return ($language === KlarnaLanguage::DE); case KlarnaCountry::NL: return ($language === KlarnaLanguage::NL); case KlarnaCountry::FI: return ($language === KlarnaLanguage::FI); case KlarnaCountry::DK: return ($language === KlarnaLanguage::DA); case KlarnaCountry::NO: return ($language === KlarnaLanguage::NB); case KlarnaCountry::SE: return ($language === KlarnaLanguage::SV); default: //Country not yet supported by Klarna. return false; } } /** * Checks country against language and returns true if they match. * * @param int $country {@link KlarnaCountry} * @param int $currency {@link KlarnaCurrency} * * @deprecated Do not use. * * @return bool */ public static function checkCurrency($country, $currency) { switch($country) { case KlarnaCountry::AT: case KlarnaCountry::DE: case KlarnaCountry::NL: case KlarnaCountry::FI: return ($currency === KlarnaCurrency::EUR); case KlarnaCountry::DK: return ($currency === KlarnaCurrency::DKK); case KlarnaCountry::NO: return ($currency === KlarnaCurrency::NOK); case KlarnaCountry::SE: return ($currency === KlarnaCurrency::SEK); default: //Country not yet supported by Klarna. return false; } } /** * Get language for supplied country. Defaults to English. * * @param int $country KlarnaCountry constant * * @deprecated Do not use. * * @return int */ public static function getLanguage($country) { switch($country) { case KlarnaCountry::AT: case KlarnaCountry::DE: return KlarnaLanguage::DE; case KlarnaCountry::NL: return KlarnaLanguage::NL; case KlarnaCountry::FI: return KlarnaLanguage::FI; case KlarnaCountry::DK: return KlarnaLanguage::DA; case KlarnaCountry::NO: return KlarnaLanguage::NB; case KlarnaCountry::SE: return KlarnaLanguage::SV; default: return KlarnaLanguage::EN; } } /** * Get currency for supplied country * * @param int $country KlarnaCountry constant * * @deprecated Do not use. * * @return int|false */ public static function getCurrency($country) { switch($country) { case KlarnaCountry::AT: case KlarnaCountry::DE: case KlarnaCountry::NL: case KlarnaCountry::FI: return KlarnaCurrency::EUR; case KlarnaCountry::DK: return KlarnaCurrency::DKK; case KlarnaCountry::NO: return KlarnaCurrency::NOK; case KlarnaCountry::SE: return KlarnaCurrency::SEK; default: return false; } } private static $_tlcFlip = array(); /** * Cache for the flipped country array * * @var array */ private static $_countryFlip = array(); /** * Array containing all countries and their KRED Code * * @var array */ private static $_countries = array( 'AF' => 1, // AFGHANISTAN 'AX' => 2, // ÅLAND ISLANDS 'AL' => 3, // ALBANIA 'DZ' => 4, // ALGERIA 'AS' => 5, // AMERICAN SAMOA 'AD' => 6, // ANDORRA 'AO' => 7, // ANGOLA 'AI' => 8, // ANGUILLA 'AQ' => 9, // ANTARCTICA 'AG' => 10, // ANTIGUA AND BARBUDA 'AR' => 11, // ARGENTINA 'AM' => 12, // ARMENIA 'AW' => 13, // ARUBA 'AU' => 14, // AUSTRALIA 'AT' => 15, // AUSTRIA 'AZ' => 16, // AZERBAIJAN 'BS' => 17, // BAHAMAS 'BH' => 18, // BAHRAIN 'BD' => 19, // BANGLADESH 'BB' => 20, // BARBADOS 'BY' => 21, // BELARUS 'BE' => 22, // BELGIUM 'BZ' => 23, // BELIZE 'BJ' => 24, // BENIN 'BM' => 25, // BERMUDA 'BT' => 26, // BHUTAN 'BO' => 27, // BOLIVIA 'BA' => 28, // BOSNIA AND HERZEGOVINA 'BW' => 29, // BOTSWANA 'BV' => 30, // BOUVET ISLAND 'BR' => 31, // BRAZIL 'IO' => 32, // BRITISH INDIAN OCEAN TERRITORY 'BN' => 33, // BRUNEI DARUSSALAM 'BG' => 34, // BULGARIA 'BF' => 35, // BURKINA FASO 'BI' => 36, // BURUNDI 'KH' => 37, // CAMBODIA 'CM' => 38, // CAMEROON 'CA' => 39, // CANADA 'CV' => 40, // CAPE VERDE 'KY' => 41, // CAYMAN ISLANDS 'CF' => 42, // CENTRAL AFRICAN REPUBLIC 'TD' => 43, // CHAD 'CL' => 44, // CHILE 'CN' => 45, // CHINA 'CX' => 46, // CHRISTMAS ISLAND 'CC' => 47, // COCOS (KEELING) ISLANDS 'CO' => 48, // COLOMBIA 'KM' => 49, // COMOROS 'CG' => 50, // CONGO 'CD' => 51, // CONGO, THE DEMOCRATIC REPUBLIC OF THE 'CK' => 52, // COOK ISLANDS 'CR' => 53, // COSTA RICA 'CI' => 54, // COTE D'IVOIRE 'HR' => 55, // CROATIA 'CU' => 56, // CUBA 'CY' => 57, // CYPRUS 'CZ' => 58, // CZECH REPUBLIC 'DK' => 59, // DENMARK 'DJ' => 60, // DJIBOUTI 'DM' => 61, // DOMINICA 'DO' => 62, // DOMINICAN REPUBLIC 'EC' => 63, // ECUADOR 'EG' => 64, // EGYPT 'SV' => 65, // EL SALVADOR 'GQ' => 66, // EQUATORIAL GUINEA 'ER' => 67, // ERITREA 'EE' => 68, // ESTONIA 'ET' => 69, // ETHIOPIA 'FK' => 70, // FALKLAND ISLANDS (MALVINAS) 'FO' => 71, // FAROE ISLANDS 'FJ' => 72, // FIJI 'FI' => 73, // FINLAND 'FR' => 74, // FRANCE 'GF' => 75, // FRENCH GUIANA 'PF' => 76, // FRENCH POLYNESIA 'TF' => 77, // FRENCH SOUTHERN TERRITORIES 'GA' => 78, // GABON 'GM' => 79, // GAMBIA 'GE' => 80, // GEORGIA 'DE' => 81, // GERMANY 'GH' => 82, // GHANA 'GI' => 83, // GIBRALTAR 'GR' => 84, // GREECE 'GL' => 85, // GREENLAND 'GD' => 86, // GRENADA 'GP' => 87, // GUADELOUPE 'GU' => 88, // GUAM 'GT' => 89, // GUATEMALA 'GG' => 90, // GUERNSEY 'GN' => 91, // GUINEA 'GW' => 92, // GUINEA-BISSAU 'GY' => 93, // GUYANA 'HT' => 94, // HAITI 'HM' => 95, // HEARD ISLAND AND MCDONALD ISLANDS 'VA' => 96, // HOLY SEE (VATICAN CITY STATE) 'HN' => 97, // HONDURAS 'HK' => 98, // HONG KONG 'HU' => 99, // HUNGARY 'IS' => 100, // ICELAND 'IN' => 101, // INDIA 'ID' => 102, // INDONESIA 'IR' => 103, // IRAN, ISLAMIC REPUBLIC OF 'IQ' => 104, // IRAQ 'IE' => 105, // IRELAND 'IM' => 106, // ISLE OF MAN 'IL' => 107, // ISRAEL 'IT' => 108, // ITALY 'JM' => 109, // JAMAICA 'JP' => 110, // JAPAN 'JE' => 111, // JERSEY 'JO' => 112, // JORDAN 'KZ' => 113, // KAZAKHSTAN 'KE' => 114, // KENYA 'KI' => 115, // KIRIBATI 'KP' => 116, // KOREA, DEMOCRATIC PEOPLE'S REPUBLIC OF 'KR' => 117, // KOREA, REPUBLIC OF 'KW' => 118, // KUWAIT 'KG' => 119, // KYRGYZSTAN 'LA' => 120, // LAO PEOPLE'S DEMOCRATIC REPUBLIC 'LV' => 121, // LATVIA 'LB' => 122, // LEBANON 'LS' => 123, // LESOTHO 'LR' => 124, // LIBERIA 'LY' => 125, // LIBYAN ARAB JAMAHIRIYA 'LI' => 126, // LIECHTENSTEIN 'LT' => 127, // LITHUANIA 'LU' => 128, // LUXEMBOURG 'MO' => 129, // MACAO 'MK' => 130, // MACEDONIA, THE FORMER YUGOSLAV REPUBLIC OF 'MG' => 131, // MADAGASCAR 'MW' => 132, // MALAWI 'MY' => 133, // MALAYSIA 'MV' => 134, // MALDIVES 'ML' => 135, // MALI 'MT' => 136, // MALTA 'MH' => 137, // MARSHALL ISLANDS 'MQ' => 138, // MARTINIQUE 'MR' => 139, // MAURITANIA 'MU' => 140, // MAURITIUS 'YT' => 141, // MAYOTTE 'MX' => 142, // MEXICO 'FM' => 143, // MICRONESIA FEDERATED STATES OF 'MD' => 144, // MOLDOVA, REPUBLIC OF 'MC' => 145, // MONACO 'MN' => 146, // MONGOLIA 'MS' => 147, // MONTSERRAT 'MA' => 148, // MOROCCO 'MZ' => 149, // MOZAMBIQUE 'MM' => 150, // MYANMAR 'NA' => 151, // NAMIBIA 'NR' => 152, // NAURU 'NP' => 153, // NEPAL 'NL' => 154, // NETHERLANDS 'AN' => 155, // NETHERLANDS ANTILLES 'NC' => 156, // NEW CALEDONIA 'NZ' => 157, // NEW ZEALAND 'NI' => 158, // NICARAGUA 'NE' => 159, // NIGER 'NG' => 160, // NIGERIA 'NU' => 161, // NIUE 'NF' => 162, // NORFOLK ISLAND 'MP' => 163, // NORTHERN MARIANA ISLANDS 'NO' => 164, // NORWAY 'OM' => 165, // OMAN 'PK' => 166, // PAKISTAN 'PW' => 167, // PALAU 'PS' => 168, // PALESTINIAN TERRITORY OCCUPIED 'PA' => 169, // PANAMA 'PG' => 170, // PAPUA NEW GUINEA 'PY' => 171, // PARAGUAY 'PE' => 172, // PERU 'PH' => 173, // PHILIPPINES 'PN' => 174, // PITCAIRN 'PL' => 175, // POLAND 'PT' => 176, // PORTUGAL 'PR' => 177, // PUERTO RICO 'QA' => 178, // QATAR 'RE' => 179, // REUNION 'RO' => 180, // ROMANIA 'RU' => 181, // RUSSIAN FEDERATION 'RW' => 182, // RWANDA 'SH' => 183, // SAINT HELENA 'KN' => 184, // SAINT KITTS AND NEVIS 'LC' => 185, // SAINT LUCIA 'PM' => 186, // SAINT PIERRE AND MIQUELON 'VC' => 187, // SAINT VINCENT AND THE GRENADINES 'WS' => 188, // SAMOA 'SM' => 189, // SAN MARINO 'ST' => 190, // SAO TOME AND PRINCIPE 'SA' => 191, // SAUDI ARABIA 'SN' => 192, // SENEGAL 'CS' => 193, // SERBIA AND MONTENEGRO 'SC' => 194, // SEYCHELLES 'SL' => 195, // SIERRA LEONE 'SG' => 196, // SINGAPORE 'SK' => 197, // SLOVAKIA 'SI' => 198, // SLOVENIA 'SB' => 199, // SOLOMON ISLANDS 'SO' => 200, // SOMALIA 'ZA' => 201, // SOUTH AFRICA 'GS' => 202, // SOUTH GEORGIA AND THE SOUTH SANDWICH ISLANDS 'ES' => 203, // SPAIN 'LK' => 204, // SRI LANKA 'SD' => 205, // SUDAN 'SR' => 206, // SURINAME 'SJ' => 207, // SVALBARD AND JAN MAYEN 'SZ' => 208, // SWAZILAND 'SE' => 209, // SWEDEN 'CH' => 210, // SWITZERLAND 'SY' => 211, // SYRIAN ARAB REPUBLIC 'TW' => 212, // TAIWAN PROVINCE OF CHINA 'TJ' => 213, // TAJIKISTAN 'TZ' => 214, // TANZANIA, UNITED REPUBLIC OF 'TH' => 215, // THAILAND 'TL' => 216, // TIMOR-LESTE 'TG' => 217, // TOGO 'TK' => 218, // TOKELAU 'TO' => 219, // TONGA 'TT' => 220, // TRINIDAD AND TOBAGO 'TN' => 221, // TUNISIA 'TR' => 222, // TURKEY 'TM' => 223, // TURKMENISTAN 'TC' => 224, // TURKS AND CAICOS ISLANDS 'TV' => 225, // TUVALU 'UG' => 226, // UGANDA 'UA' => 227, // UKRAINE 'AE' => 228, // UNITED ARAB EMIRATES 'GB' => 229, // UNITED KINGDOM 'US' => 230, // UNITED STATES 'UM' => 231, // UNITED STATES MINOR OUTLYING ISLANDS 'UY' => 232, // URUGUAY 'UZ' => 233, // UZBEKISTAN 'VU' => 234, // VANUATU 'VE' => 235, // VENEZUELA 'VN' => 236, // VIET NAM 'VG' => 237, // VIRGIN ISLANDS, BRITISH 'VI' => 238, // VIRGIN ISLANDS, US 'WF' => 239, // WALLIS AND FUTUNA 'EH' => 240, // WESTERN SAHARA 'YE' => 241, // YEMEN 'ZM' => 242, // ZAMBIA 'ZW' => 243 // ZIMBABWE ); private static $_tlcMap = array( 'AF' => 'AFG', 'AX' => 'ALA', 'AL' => 'ALB', 'DZ' => 'DZA', 'AS' => 'ASM', 'AD' => 'AND', 'AO' => 'AGO', 'AI' => 'AIA', 'AQ' => 'ATA', 'AG' => 'ATG', 'AR' => 'ARG', 'AM' => 'ARM', 'AW' => 'ABW', 'AU' => 'AUS', 'AT' => 'AUT', 'AZ' => 'AZE', 'BS' => 'BHS', 'BH' => 'BHR', 'BD' => 'BGD', 'BB' => 'BRB', 'BY' => 'BLR', 'BE' => 'BEL', 'BZ' => 'BLZ', 'BJ' => 'BEN', 'BM' => 'BMU', 'BT' => 'BTN', 'BO' => 'BOL', 'BQ' => 'BES', 'BA' => 'BIH', 'BW' => 'BWA', 'BV' => 'BVT', 'BR' => 'BRA', 'IO' => 'IOT', 'BN' => 'BRN', 'BG' => 'BGR', 'BF' => 'BFA', 'BI' => 'BDI', 'KH' => 'KHM', 'CM' => 'CMR', 'CA' => 'CAN', 'CV' => 'CPV', 'KY' => 'CYM', 'CF' => 'CAF', 'TD' => 'TCD', 'CL' => 'CHL', 'CN' => 'CHN', 'CX' => 'CXR', 'CC' => 'CCK', 'CO' => 'COL', 'KM' => 'COM', 'CG' => 'COG', 'CD' => 'COD', 'CK' => 'COK', 'CR' => 'CRI', 'CI' => 'CIV', 'HR' => 'HRV', 'CU' => 'CUB', 'CW' => 'CUW', 'CY' => 'CYP', 'CZ' => 'CZE', 'DK' => 'DNK', 'DJ' => 'DJI', 'DM' => 'DMA', 'DO' => 'DOM', 'EC' => 'ECU', 'EG' => 'EGY', 'SV' => 'SLV', 'GQ' => 'GNQ', 'ER' => 'ERI', 'EE' => 'EST', 'ET' => 'ETH', 'FK' => 'FLK', 'FO' => 'FRO', 'FJ' => 'FJI', 'FI' => 'FIN', 'FR' => 'FRA', 'GF' => 'GUF', 'PF' => 'PYF', 'TF' => 'ATF', 'GA' => 'GAB', 'GM' => 'GMB', 'GE' => 'GEO', 'DE' => 'DEU', 'GH' => 'GHA', 'GI' => 'GIB', 'GR' => 'GRC', 'GL' => 'GRL', 'GD' => 'GRD', 'GP' => 'GLP', 'GU' => 'GUM', 'GT' => 'GTM', 'GG' => 'GGY', 'GN' => 'GIN', 'GW' => 'GNB', 'GY' => 'GUY', 'HT' => 'HTI', 'HM' => 'HMD', 'VA' => 'VAT', 'HN' => 'HND', 'HK' => 'HKG', 'HU' => 'HUN', 'IS' => 'ISL', 'IN' => 'IND', 'ID' => 'IDN', 'IR' => 'IRN', 'IQ' => 'IRQ', 'IE' => 'IRL', 'IM' => 'IMN', 'IL' => 'ISR', 'IT' => 'ITA', 'JM' => 'JAM', 'JP' => 'JPN', 'JE' => 'JEY', 'JO' => 'JOR', 'KZ' => 'KAZ', 'KE' => 'KEN', 'KI' => 'KIR', 'KP' => 'PRK', 'KR' => 'KOR', 'KW' => 'KWT', 'KG' => 'KGZ', 'LA' => 'LAO', 'LV' => 'LVA', 'LB' => 'LBN', 'LS' => 'LSO', 'LR' => 'LBR', 'LY' => 'LBY', 'LI' => 'LIE', 'LT' => 'LTU', 'LU' => 'LUX', 'MO' => 'MAC', 'MK' => 'MKD', 'MG' => 'MDG', 'MW' => 'MWI', 'MY' => 'MYS', 'MV' => 'MDV', 'ML' => 'MLI', 'MT' => 'MLT', 'MH' => 'MHL', 'MQ' => 'MTQ', 'MR' => 'MRT', 'MU' => 'MUS', 'YT' => 'MYT', 'MX' => 'MEX', 'FM' => 'FSM', 'MD' => 'MDA', 'MC' => 'MCO', 'MN' => 'MNG', 'ME' => 'MNE', 'MS' => 'MSR', 'MA' => 'MAR', 'MZ' => 'MOZ', 'MM' => 'MMR', 'NA' => 'NAM', 'NR' => 'NRU', 'NP' => 'NPL', 'NL' => 'NLD', 'NC' => 'NCL', 'NZ' => 'NZL', 'NI' => 'NIC', 'NE' => 'NER', 'NG' => 'NGA', 'NU' => 'NIU', 'NF' => 'NFK', 'MP' => 'MNP', 'NO' => 'NOR', 'OM' => 'OMN', 'PK' => 'PAK', 'PW' => 'PLW', 'PS' => 'PSE', 'PA' => 'PAN', 'PG' => 'PNG', 'PY' => 'PRY', 'PE' => 'PER', 'PH' => 'PHL', 'PN' => 'PCN', 'PL' => 'POL', 'PT' => 'PRT', 'PR' => 'PRI', 'QA' => 'QAT', 'RE' => 'REU', 'RO' => 'ROU', 'RU' => 'RUS', 'RW' => 'RWA', 'BL' => 'BLM', 'SH' => 'SHN', 'KN' => 'KNA', 'LC' => 'LCA', 'MF' => 'MAF', 'PM' => 'SPM', 'VC' => 'VCT', 'WS' => 'WSM', 'SM' => 'SMR', 'ST' => 'STP', 'SA' => 'SAU', 'SN' => 'SEN', 'RS' => 'SRB', 'SC' => 'SYC', 'SL' => 'SLE', 'SG' => 'SGP', 'SX' => 'SXM', 'SK' => 'SVK', 'SI' => 'SVN', 'SB' => 'SLB', 'SO' => 'SOM', 'ZA' => 'ZAF', 'GS' => 'SGS', 'SS' => 'SSD', 'ES' => 'ESP', 'LK' => 'LKA', 'SD' => 'SDN', 'SR' => 'SUR', 'SJ' => 'SJM', 'SZ' => 'SWZ', 'SE' => 'SWE', 'CH' => 'CHE', 'SY' => 'SYR', 'TW' => 'TWN', 'TJ' => 'TJK', 'TZ' => 'TZA', 'TH' => 'THA', 'TL' => 'TLS', 'TG' => 'TGO', 'TK' => 'TKL', 'TO' => 'TON', 'TT' => 'TTO', 'TN' => 'TUN', 'TR' => 'TUR', 'TM' => 'TKM', 'TC' => 'TCA', 'TV' => 'TUV', 'UG' => 'UGA', 'UA' => 'UKR', 'AE' => 'ARE', 'GB' => 'GBR', 'US' => 'USA', 'UM' => 'UMI', 'UY' => 'URY', 'UZ' => 'UZB', 'VU' => 'VUT', 'VE' => 'VEN', 'VN' => 'VNM', 'VG' => 'VGB', 'VI' => 'VIR', 'WF' => 'WLF', 'EH' => 'ESH', 'YE' => 'YEM', 'ZM' => 'ZMB', 'ZW' => 'ZWE' ); } Encoding.php000066600000014350151375520470007023 0ustar00 * @copyright 2012 Klarna AB (http://klarna.com) * @license http://opensource.org/licenses/BSD-2-Clause BSD-2 * @link http://integration.klarna.com/ */ defined ('_JEXEC') or die(); require_once 'Exceptions.php'; /** * Encoding class * * @category Payment * @package KlarnaAPI * @author MS Dev * @copyright 2012 Klarna AB (http://klarna.com) * @license http://opensource.org/licenses/BSD-2-Clause BSD-2 * @link http://integration.klarna.com/ */ class KlarnaEncoding { /** * PNO/SSN encoding for Sweden. * * @var int */ const PNO_SE = 2; /** * PNO/SSN encoding for Norway. * * @var int */ const PNO_NO = 3; /** * PNO/SSN encoding for Finland. * * @var int */ const PNO_FI = 4; /** * PNO/SSN encoding for Denmark. * * @var int */ const PNO_DK = 5; /** * PNO/SSN encoding for Germany. * * @var int */ const PNO_DE = 6; /** * PNO/SSN encoding for Netherlands. * * @var int */ const PNO_NL = 7; /** * PNO/SSN encoding for Austria. * * @var int */ const PNO_AT = 8; /** * Encoding constant for customer numbers. * * @see Klarna::setCustomerNo() * @var int */ const CUSTNO = 1000; /** * Encoding constant for email address. * * @var int */ const EMAIL = 1001; /** * Encoding constant for cell numbers. * * @var int */ const CELLNO = 1002; /** * Encoding constant for bank bic + account number. * * @var int */ const BANK_BIC_ACC_NO = 1003; /** * Returns the constant for the wanted country. * * @param string $country country * * @return int */ public static function get($country) { switch (strtoupper($country)) { case "DE": return KlarnaEncoding::PNO_DE; case "DK": return KlarnaEncoding::PNO_DK; case "FI": return KlarnaEncoding::PNO_FI; case "NL": return KlarnaEncoding::PNO_NL; case "NO": return KlarnaEncoding::PNO_NO; case "SE": return KlarnaEncoding::PNO_SE; case "AT": return KlarnaEncoding::PNO_AT; default: return -1; } } /** * Returns a regexp string for the specified encoding constant. * * @param int $enc PNO/SSN encoding constant. * * @return string The regular expression. * @throws Klarna_UnknownEncodingException */ public static function getRegexp($enc) { switch($enc) { case self::PNO_SE: /* * All positions except C contain numbers 0-9. * * PNO: * YYYYMMDDCNNNN, C = -|+ length 13 * YYYYMMDDNNNN 12 * YYMMDDCNNNN 11 * YYMMDDNNNN 10 * * ORGNO: * XXXXXXNNNN * XXXXXX-NNNN * 16XXXXXXNNNN * 16XXXXXX-NNNN * */ return '/^[0-9]{6,6}(([0-9]{2,2}[-\+]{1,1}[0-9]{4,4})|([-\+]'. '{1,1}[0-9]{4,4})|([0-9]{4,6}))$/'; case self::PNO_NO: /* * All positions contain numbers 0-9. * * Pno * DDMMYYIIIKK ("fodelsenummer" or "D-nummer") length = 11 * DDMMYY-IIIKK ("fodelsenummer" or "D-nummer") length = 12 * DDMMYYYYIIIKK ("fodelsenummer" or "D-nummer") length = 13 * DDMMYYYY-IIIKK ("fodelsenummer" or "D-nummer") length = 14 * * Orgno * Starts with 8 or 9. * * NNNNNNNNK (orgno) length = 9 */ return '/^[0-9]{6,6}((-[0-9]{5,5})|([0-9]{2,2}((-[0-9]'. '{5,5})|([0-9]{1,1})|([0-9]{3,3})|([0-9]{5,5))))$/'; case self::PNO_FI: /* * Pno * DDMMYYCIIIT * DDMMYYIIIT * C = century, '+' = 1800, '-' = 1900 och 'A' = 2000. * I = 0-9 * T = 0-9, A-F, H, J, K-N, P, R-Y * * Orgno * NNNNNNN-T * NNNNNNNT * T = 0-9, A-F, H, J, K-N, P, R-Y */ return '/^[0-9]{6,6}(([A\+-]{1,1}[0-9]{3,3}[0-9A-FHJK-NPR-Y]'. '{1,1})|([0-9]{3,3}[0-9A-FHJK-NPR-Y]{1,1})|([0-9]{1,1}-{0,1}'. '[0-9A-FHJK-NPR-Y]{1,1}))$/i'; case self::PNO_DK: /* * Pno * DDMMYYNNNG length 10 * G = gender, odd/even for men/women. * * Orgno * XXXXXXXX length 8 */ return '/^[0-9]{8,8}([0-9]{2,2})?$/'; case self::PNO_NL: case self::PNO_DE: /** * Pno * DDMMYYYYG length 9 * DDMMYYYY 8 * * Orgno * XXXXXXX 7 company org nr */ return '/^[0-9]{7,9}$/'; case self::EMAIL: /** * Validates an email. */ return '/^[_a-zA-Z0-9-]+(\.[_a-zA-Z0-9-]+)*@[a-zA-Z0-9-]'. '+(\.[a-zA-Z0-9-]+)*(\.[a-zA-Z0-9-][a-zA-Z0-9-]+)+$/'; case self::CELLNO: /** * Validates a cellno. * @TODO Is this encoding only for Sweden? */ return '/^07[\ \-0-9]{8,13}$/'; default: throw new Klarna_UnknownEncodingException($enc); } } /** * Checks if the specified PNO is correct according to specified encoding constant. * * @param string $pno PNO/SSN string. * @param int $enc {@link KlarnaEncoding PNO/SSN encoding} constant. * * @return bool True if correct. */ public static function checkPNO($pno, $enc = null) { return strlen($pno) > 0; } } Flags.php000066600000014175151375520470006336 0ustar00 * @copyright 2012 Klarna AB (http://klarna.com) * @license http://opensource.org/licenses/BSD-2-Clause BSD-2 * @link http://integration.klarna.com/ */ /** * Flag Constants class * * @category Payment * @package KlarnaAPI * @author MS Dev * @copyright 2012 Klarna AB (http://klarna.com) * @license http://opensource.org/licenses/BSD-2-Clause BSD-2 * @link http://integration.klarna.com/ */ class KlarnaFlags { /** * Specifies that no flag is to be used. * * @var int */ const NO_FLAG = 0; //Gender flags /** * Indicates that the person is a female.
* Use "" or null when unspecified.
* * @var int */ const FEMALE = 0; /** * Indicates that the person is a male.
* Use "" or null when unspecified.
* * @var int */ const MALE = 1; //Order status constants /** * This signifies that the invoice or reservation is accepted. * * @var int */ const ACCEPTED = 1; /** * This signifies that the invoice or reservation is pending, will be set * to accepted or denied. * * @var int */ const PENDING = 2; /** * This signifies that the invoice or reservation is denied. * * @var int */ const DENIED = 3; //Get_address constants /** * A code which indicates that all first names should be returned with the * address. * * Formerly refered to as GA_OLD. * * @var int */ const GA_ALL = 1; /** * A code which indicates that only the last name should be returned with * the address. * * Formerly referd to as GA_NEW. * * @var int */ const GA_LAST = 2; /** * A code which indicates that the given name should be returned with * the address. If no given name is registered, this will behave as * {@link KlarnaFlags::GA_ALL GA_ALL}. * */ const GA_GIVEN = 5; //Article/goods constants /** * Quantity measured in 1/1000s. * * @var int */ const PRINT_1000 = 1; /** * Quantity measured in 1/100s. * * @var int */ const PRINT_100 = 2; /** * Quantity measured in 1/10s. * * @var int */ const PRINT_10 = 4; /** * Indicates that the item is a shipment fee. * * Update_charge_amount (1) * * @var int */ const IS_SHIPMENT = 8; /** * Indicates that the item is a handling fee. * * Update_charge_amount (2) * * @var int */ const IS_HANDLING = 16; /** * Article price including VAT. * * @var int */ const INC_VAT = 32; //Miscellaneous /** * Signifies that this is to be displayed in the checkout.
* Used for part payment.
* * @var int */ const CHECKOUT_PAGE = 0; /** * Signifies that this is to be displayed in the product page.
* Used for part payment.
* * @var int */ const PRODUCT_PAGE = 1; /** * Signifies that the specified address is billing address. * * @var int */ const IS_BILLING = 100; /** * Signifies that the specified address is shipping address. * * @var int */ const IS_SHIPPING = 101; //Invoice and Reservation /** * Indicates that the purchase is a test invoice/part payment. * * @var int */ const TEST_MODE = 2; /** * PClass id/value for invoices. * * @see KlarnaPClass::INVOICE. * @var int */ const PCLASS_INVOICE = -1; //Invoice /** * Activates an invoices automatically, requires setting in Klarna Online. * * If you designate this flag an invoice is created directly in the active * state, i.e. Klarna will buy the invoice immediately. * * @var int */ const AUTO_ACTIVATE = 1; /** * Creates a pre-pay invoice. * * @var int * * @deprecated Do not use. */ const PRE_PAY = 8; /** * Used to flag a purchase as sensitive order. * * @var int */ const SENSITIVE_ORDER = 1024; /** * Used to return an array with long and short ocr number. * * @see Klarna::addTransaction() * @var int */ const RETURN_OCR = 8192; /** * Specifies the shipment type as normal. * * @var int */ const NORMAL_SHIPMENT = 1; /** * Specifies the shipment type as express. * * @var int */ const EXPRESS_SHIPMENT = 2; //Mobile (Invoice) flags /** * Marks the transaction as Klarna mobile. * * @var int */ const M_PHONE_TRANSACTION = 262144; /** * Sends a pin code to the phone sent in pno. * * @var int */ const M_SEND_PHONE_PIN = 524288; //Reservation flags /** * Signifies that the amount specified is the new amount. * * @var int */ const NEW_AMOUNT = 0; /** * Signifies that the amount specified is to be added. * * @var int */ const ADD_AMOUNT = 1; /** * Sends the invoice by mail when activating a reservation. * * @var int */ const RSRV_SEND_BY_MAIL = 4; /** * Sends the invoice by e-mail when activating a reservation. * * @var int */ const RSRV_SEND_BY_EMAIL = 8; /** * Used for partial deliveries, this flag saves the reservation number so * it can be used again. * * @var int */ const RSRV_PRESERVE_RESERVATION = 16; /** * Used to flag a purchase as sensitive order. * * @var int */ const RSRV_SENSITIVE_ORDER = 32; /** * Marks the transaction as Klarna mobile. * * @var int */ const RSRV_PHONE_TRANSACTION = 512; /** * Sends a pin code to the mobile number. * * @var int */ const RSRV_SEND_PHONE_PIN = 1024; }