Skip to content
Snippets Groups Projects
Select Git revision
  • bb74ead0f5780a0a38073117d862ee20b6767d7c
  • 3.9 default
  • develop
  • 6.0
  • 5.0
  • 4.0
  • scrutinizer-patch-4
  • scrutinizer-patch-3
  • scrutinizer-patch-2
  • scrutinizer-patch-1
  • 3.7
  • 3.8
  • 3.6
  • 3.9_backported
  • 3.8_backported
  • 3.7_backported
  • 3.5
  • 3.6_backported
  • 3.5_backported
  • 3.4
  • 3.3_backported
  • 6.0.4
  • 6.0.3
  • 5.0.7
  • 6.0.2
  • 6.0.1
  • 5.0.6
  • 6.0.0
  • 5.0.5
  • 6.0.0-rc
  • 5.0.4
  • 6.0.0-beta
  • 5.0.3
  • 4.0.6
  • 5.0.2
  • 5.0.1
  • 4.0.5
  • 5.0.0
  • 4.0.4
  • 5.0.0-rc2
  • 5.0.0-rc1
41 results

inc.php

Blame
  • paypal.lib.php 31.65 KiB
    <?php
    /* Copyright (C) 2008-2012	Laurent Destailleur	<eldy@users.sourceforge.net>
     * Copyright (C) 2011-2012	Regis Houssin		<regis.houssin@capnetworks.com>
     *
     * This program is free software; you can redistribute it and/or modify
     * it under the terms of the GNU General Public License as published by
     * the Free Software Foundation; either version 3 of the License, or
     * (at your option) any later version.
     *
     * This program is distributed in the hope that it will be useful,
     * but WITHOUT ANY WARRANTY; without even the implied warranty of
     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
     * GNU General Public License for more details.
     *
     * You should have received a copy of the GNU General Public License
     * along with this program. If not, see <http://www.gnu.org/licenses/>.
     */
    
    /**
     *	\file			htdocs/paypal/lib/paypal.lib.php
     *  \ingroup		paypal
     *  \brief			Library for common paypal functions
     */
    
    
    /**
     * Show header
     *
     * @param 	string	$title		Title
     * @param 	string	$head		More header to add
     * @return	void
     */
    function llxHeaderPaypal($title, $head = "")
    {
    	global $user, $conf, $langs;
    
    	header("Content-type: text/html; charset=".$conf->file->character_set_client);
    
    	$appli='Dolibarr';
    	if (!empty($conf->global->MAIN_APPLICATION_TITLE)) $appli=$conf->global->MAIN_APPLICATION_TITLE;
    
    	print '<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">';
    	//print '<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" http://www.w3.org/TR/1999/REC-html401-19991224/strict.dtd>';
    	print "\n";
    	print "<html>\n";
    	print "<head>\n";
    	print '<meta name="robots" content="noindex,nofollow">'."\n";
    	print '<meta name="keywords" content="dolibarr,payment,online">'."\n";
    	print '<meta name="description" content="Welcome on '.$appli.' online payment form">'."\n";
    	print "<title>".$title."</title>\n";
    	if ($head) print $head."\n";
    	if (! empty($conf->global->PAYPAL_CSS_URL)) print '<link rel="stylesheet" type="text/css" href="'.$conf->global->PAYPAL_CSS_URL.'?lang='.$langs->defaultlang.'">'."\n";
    	else
    	{
    		print '<link rel="stylesheet" type="text/css" href="'.DOL_URL_ROOT.$conf->css.'?lang='.$langs->defaultlang.'">'."\n";
    		print '<style type="text/css">';
    		print '.CTableRow1      { margin: 1px; padding: 3px; font: 12px verdana,arial; background: #e6E6eE; color: #000000; -moz-border-radius-topleft:6px; -moz-border-radius-topright:6px; -moz-border-radius-bottomleft:6px; -moz-border-radius-bottomright:6px;}';
    		print '.CTableRow2      { margin: 1px; padding: 3px; font: 12px verdana,arial; background: #FFFFFF; color: #000000; -moz-border-radius-topleft:6px; -moz-border-radius-topright:6px; -moz-border-radius-bottomleft:6px; -moz-border-radius-bottomright:6px;}';
    		print '</style>';
    	}
    
    	if ($conf->use_javascript_ajax)
    	{
    		print '<!-- Includes for JQuery (Ajax library) -->'."\n";
    		print '<link rel="stylesheet" type="text/css" href="'.DOL_URL_ROOT.'/includes/jquery/plugins/jnotify/jquery.jnotify-alt.min.css" />'."\n";          // JNotify
    
    		// Output standard javascript links
    		$ext='.js';
    
    		// JQuery. Must be before other includes
    		print '<!-- Includes JS for JQuery -->'."\n";
    		print '<script type="text/javascript" src="'.DOL_URL_ROOT.'/includes/jquery/js/jquery-latest.min'.$ext.'"></script>'."\n";
    		// jQuery jnotify
    		if (empty($conf->global->MAIN_DISABLE_JQUERY_JNOTIFY))
    		{
    			print '<script type="text/javascript" src="'.DOL_URL_ROOT.'/includes/jquery/plugins/jnotify/jquery.jnotify.min'.$ext.'"></script>'."\n";
    			print '<script type="text/javascript" src="'.DOL_URL_ROOT.'/core/js/jnotify'.$ext.'"></script>'."\n";
    		}
    	}
    	print "</head>\n";
    	print '<body style="margin: 20px;">'."\n";
    }
    
    /**
     * Show footer
     *
     * @return	void
     */
    function llxFooterPaypal()
    {
    	print "</body>\n";
    	print "</html>\n";
    }
    
    
    /**
     * Show footer of company in HTML pages
     *
     * @param   Societe		$fromcompany	Third party
     * @param   Translate	$langs			Output language
     * @return	void
     */
    function html_print_paypal_footer($fromcompany,$langs)
    {
    	global $conf;
    
    	// Juridical status
    	$line1="";
    	if ($fromcompany->forme_juridique_code)
    	{
    		$line1.=($line1?" - ":"").getFormeJuridiqueLabel($fromcompany->forme_juridique_code);
    	}
    	// Capital
    	if ($fromcompany->capital)
    	{
    		$line1.=($line1?" - ":"").$langs->transnoentities("CapitalOf",$fromcompany->capital)." ".$langs->transnoentities("Currency".$conf->currency);
    	}
    	// Prof Id 1
    	if ($fromcompany->idprof1 && ($fromcompany->country_code != 'FR' || ! $fromcompany->idprof2))
    	{
    		$field=$langs->transcountrynoentities("ProfId1",$fromcompany->country_code);
    		if (preg_match('/\((.*)\)/i',$field,$reg)) $field=$reg[1];
    		$line1.=($line1?" - ":"").$field.": ".$fromcompany->idprof1;
    	}
    	// Prof Id 2
    	if ($fromcompany->idprof2)
    	{
    		$field=$langs->transcountrynoentities("ProfId2",$fromcompany->country_code);
    		if (preg_match('/\((.*)\)/i',$field,$reg)) $field=$reg[1];
    		$line1.=($line1?" - ":"").$field.": ".$fromcompany->idprof2;
    	}
    
    	// Second line of company infos
    	$line2="";
    	// Prof Id 3
    	if ($fromcompany->idprof3)
    	{
    		$field=$langs->transcountrynoentities("ProfId3",$fromcompany->country_code);
    		if (preg_match('/\((.*)\)/i',$field,$reg)) $field=$reg[1];
    		$line2.=($line2?" - ":"").$field.": ".$fromcompany->idprof3;
    	}
    	// Prof Id 4
    	if ($fromcompany->idprof4)
    	{
    		$field=$langs->transcountrynoentities("ProfId4",$fromcompany->country_code);
    		if (preg_match('/\((.*)\)/i',$field,$reg)) $field=$reg[1];
    		$line2.=($line2?" - ":"").$field.": ".$fromcompany->idprof4;
    	}
    	// IntraCommunautary VAT
    	if ($fromcompany->tva_intra != '')
    	{
    		$line2.=($line2?" - ":"").$langs->transnoentities("VATIntraShort").": ".$fromcompany->tva_intra;
    	}
    
    	print '<br><br><hr>'."\n";
    	print '<center><font style="font-size: 10px;">'."\n";
    	print $fromcompany->nom.'<br>';
    	print $line1.'<br>';
    	print $line2;
    	print '</font></center>'."\n";
    }
    
    /**
     *  Define head array for tabs of paypal tools setup pages
     *
     *  @return			Array of head
     */
    function paypaladmin_prepare_head()
    {
    	global $langs, $conf;
    
    	$h = 0;
    	$head = array();
    
    	$head[$h][0] = DOL_URL_ROOT."/paypal/admin/paypal.php";
    	$head[$h][1] = $langs->trans("Account");
    	$head[$h][2] = 'paypalaccount';
    	$h++;
    
    	$object=new stdClass();
    
        // Show more tabs from modules
        // Entries must be declared in modules descriptor with line
        // $this->tabs = array('entity:+tabname:Title:@mymodule:/mymodule/mypage.php?id=__ID__');   to add new tab
        // $this->tabs = array('entity:-tabname);   												to remove a tab
    	complete_head_from_modules($conf,$langs,$object,$head,$h,'paypaladmin');
    
    	complete_head_from_modules($conf,$langs,$object,$head,$h,'paypaladmin','remove');
    
        return $head;
    }
    
    
    
    /**
     * Return string with full Url
     *
     * @param   string	$type		Type of URL ('free', 'order', 'invoice', 'contractline', 'membersubscription' ...)
     * @param	string	$ref		Ref of object
     * @return	string				Url string
     */
    function showPaypalPaymentUrl($type,$ref)
    {
    	global $conf, $langs;
    
    	$langs->load("paypal");
        $langs->load("paybox");
        $servicename='PayPal';
        $out='<br><br>';
        $out.=img_picto('','object_globe.png').' '.$langs->trans("ToOfferALinkForOnlinePayment",$servicename).'<br>';
        $url=getPaypalPaymentUrl(0,$type,$ref);
        $out.='<input type="text" id="paypalurl" value="'.$url.'" size="60"><br>';
        return $out;
    }
    
    
    /**
     * Return string with full Url
     *
     * @param   int		$mode		0=True url, 1=Url formated with colors
     * @param   string	$type		Type of URL ('free', 'order', 'invoice', 'contractline', 'membersubscription' ...)
     * @param	string	$ref		Ref of object
     * @param	int		$amount		Amount
     * @param	string	$freetag	Free tag
     * @return	string				Url string
     */
    function getPaypalPaymentUrl($mode,$type,$ref='',$amount='9.99',$freetag='your_free_tag')
    {
    	global $conf;
    
        if ($type == 'free')
        {
    	    $out=DOL_MAIN_URL_ROOT.'/public/paypal/newpayment.php?amount='.($mode?'<font color="#666666">':'').$amount.($mode?'</font>':'').'&tag='.($mode?'<font color="#666666">':'').$freetag.($mode?'</font>':'');
    	    if (! empty($conf->global->PAYPAL_SECURITY_TOKEN))
    	    {
    	    	if (empty($conf->global->PAYPAL_SECURITY_TOKEN_UNIQUE)) $out.='&securekey='.$conf->global->PAYPAL_SECURITY_TOKEN;
    	    	else $out.='&securekey='.dol_hash($conf->global->PAYPAL_SECURITY_TOKEN, 2);
    	    }
        }
        if ($type == 'order')
        {
            $out=DOL_MAIN_URL_ROOT.'/public/paypal/newpayment.php?source=order&ref='.($mode?'<font color="#666666">':'');
            if ($mode == 1) $out.='order_ref';
            if ($mode == 0) $out.=urlencode($ref);
    	    $out.=($mode?'</font>':'');
            if (! empty($conf->global->PAYPAL_SECURITY_TOKEN))
            {
        	    if (empty($conf->global->PAYPAL_SECURITY_TOKEN_UNIQUE)) $out.='&securekey='.$conf->global->PAYPAL_SECURITY_TOKEN;
                else
                {
                    $out.='&securekey='.($mode?'<font color="#666666">':'');
                    if ($mode == 1) $out.="hash('".$conf->global->PAYPAL_SECURITY_TOKEN."' + 'order' + order_ref)";
                    if ($mode == 0) $out.= dol_hash($conf->global->PAYPAL_SECURITY_TOKEN . 'order' . $ref, 2);
                    $out.=($mode?'</font>':'');
                }
            }
        }
        if ($type == 'invoice')
        {
            $out=DOL_MAIN_URL_ROOT.'/public/paypal/newpayment.php?source=invoice&ref='.($mode?'<font color="#666666">':'');
            if ($mode == 1) $out.='invoice_ref';
            if ($mode == 0) $out.=urlencode($ref);
    	    $out.=($mode?'</font>':'');
            if (! empty($conf->global->PAYPAL_SECURITY_TOKEN))
            {
        	    if (empty($conf->global->PAYPAL_SECURITY_TOKEN_UNIQUE)) $out.='&securekey='.$conf->global->PAYPAL_SECURITY_TOKEN;
                else
                {
                    $out.='&securekey='.($mode?'<font color="#666666">':'');
                    if ($mode == 1) $out.="hash('".$conf->global->PAYPAL_SECURITY_TOKEN."' + 'invoice' + invoice_ref)";
                    if ($mode == 0) $out.= dol_hash($conf->global->PAYPAL_SECURITY_TOKEN . 'invoice' . $ref, 2);
                    $out.=($mode?'</font>':'');
                }
            }
        }
        if ($type == 'contractline')
        {
            $out=DOL_MAIN_URL_ROOT.'/public/paypal/newpayment.php?source=contractline&ref='.($mode?'<font color="#666666">':'');
            if ($mode == 1) $out.='contractline_ref';
            if ($mode == 0) $out.=urlencode($ref);
    	    $out.=($mode?'</font>':'');
            if (! empty($conf->global->PAYPAL_SECURITY_TOKEN))
            {
        	    if (empty($conf->global->PAYPAL_SECURITY_TOKEN_UNIQUE)) $out.='&securekey='.$conf->global->PAYPAL_SECURITY_TOKEN;
                else
                {
                    $out.='&securekey='.($mode?'<font color="#666666">':'');
                    if ($mode == 1) $out.="hash('".$conf->global->PAYPAL_SECURITY_TOKEN."' + 'contactline' + contractline_ref)";
                    if ($mode == 0) $out.= dol_hash($conf->global->PAYPAL_SECURITY_TOKEN . 'contractline' . $ref, 2);
                    $out.=($mode?'</font>':'');
                }
            }
        }
        if ($type == 'membersubscription')
        {
            $out=DOL_MAIN_URL_ROOT.'/public/paypal/newpayment.php?source=membersubscription&ref='.($mode?'<font color="#666666">':'');
            if ($mode == 1) $out.='member_ref';
            if ($mode == 0) $out.=urlencode($ref);
    	    $out.=($mode?'</font>':'');
            if (! empty($conf->global->PAYPAL_SECURITY_TOKEN))
            {
        	    if (empty($conf->global->PAYPAL_SECURITY_TOKEN_UNIQUE)) $out.='&securekey='.$conf->global->PAYPAL_SECURITY_TOKEN;
                else
                {
                    $out.='&securekey='.($mode?'<font color="#666666">':'');
                    if ($mode == 1) $out.="hash('".$conf->global->PAYPAL_SECURITY_TOKEN."' + 'membersubscription' + member_ref)";
                    if ($mode == 0) $out.= dol_hash($conf->global->PAYPAL_SECURITY_TOKEN . 'membersubscription' . $ref, 2);
                    $out.=($mode?'</font>':'');
                }
            }
        }
    
        // For multicompany
        //$out.="&entity=".$conf->entity; // This should not be into link. Link contains already a ref of an object that allow to retreive entity
    
        return $out;
    }
    
    
    /**
     * Send redirect to paypal to browser
     *
     * @param	float	$paymentAmount		Amount
     * @param   string	$currencyCodeType	Currency code
     * @param	string	$paymentType		Payment type
     * @param  	string	$returnURL			Url to use if payment is OK
     * @param   string	$cancelURL			Url to use if payment is KO
     * @param   string	$tag				Tag
     * @return	void
     */
    function print_paypal_redirect($paymentAmount,$currencyCodeType,$paymentType,$returnURL,$cancelURL,$tag)
    {
        //declaring of global variables
        global $conf, $langs;
        global $API_Endpoint, $API_Url, $API_version, $USE_PROXY, $PROXY_HOST, $PROXY_PORT;
        global $PAYPAL_API_USER, $PAYPAL_API_PASSWORD, $PAYPAL_API_SIGNATURE;
    
        global $shipToName, $shipToStreet, $shipToCity, $shipToState, $shipToCountryCode, $shipToZip, $shipToStreet2, $phoneNum;
        global $email, $desc;
    
        //'------------------------------------
        //' Calls the SetExpressCheckout API call
        //'
        //'-------------------------------------------------
    
        if (empty($conf->global->PAYPAL_API_INTEGRAL_OR_PAYPALONLY)) $conf->global->PAYPAL_API_INTEGRAL_OR_PAYPALONLY='integral';
    
        $solutionType='Sole';
        $landingPage='Billing';
        // For payment with Paypal only
        if ($conf->global->PAYPAL_API_INTEGRAL_OR_PAYPALONLY == 'paypalonly')
        {
            $solutionType='Mark';
            $landingPage='Login';
        }
        // For payment with Credit card or Paypal
        if ($conf->global->PAYPAL_API_INTEGRAL_OR_PAYPALONLY == 'integral')
        {
            $solutionType='Sole';
            $landingPage='Billing';
        }
        // For payment with Credit card
        if ($conf->global->PAYPAL_API_INTEGRAL_OR_PAYPALONLY == 'cconly')
        {
            $solutionType='Sole';
            $landingPage='Billing';
        }
    
        dol_syslog("expresscheckout redirect with callSetExpressCheckout $paymentAmount, $currencyCodeType, $paymentType, $returnURL, $cancelURL, $tag, $solutionType, $landingPage, $shipToName, $shipToStreet, $shipToCity, $shipToState, $shipToCountryCode, $shipToZip, $shipToStreet2, $phoneNum");
        $resArray = callSetExpressCheckout(
            $paymentAmount,
            $currencyCodeType,
            $paymentType,
            $returnURL,
            $cancelURL,
            $tag,
            $solutionType,
            $landingPage,
            $shipToName,
            $shipToStreet,
            $shipToCity,
            $shipToState,
            $shipToCountryCode,
            $shipToZip,
            $shipToStreet2,
            $phoneNum,
            $email,
            $desc
        );
    
        $ack = strtoupper($resArray["ACK"]);
        if($ack=="SUCCESS" || $ack=="SUCCESSWITHWARNING")
        {
            $token=$resArray["TOKEN"];
    
            // Redirect to paypal.com here
            $payPalURL = $API_Url . $token;
            header("Location: ".$payPalURL);
            exit;
        }
        else
        {
            //Display a user friendly Error on the page using any of the following error information returned by PayPal
            $ErrorCode = urldecode($resArray["L_ERRORCODE0"]);
            $ErrorShortMsg = urldecode($resArray["L_SHORTMESSAGE0"]);
            $ErrorLongMsg = urldecode($resArray["L_LONGMESSAGE0"]);
            $ErrorSeverityCode = urldecode($resArray["L_SEVERITYCODE0"]);
    
            echo "SetExpressCheckout API call failed. <br>\n";
            echo "Detailed Error Message: " . $ErrorLongMsg." <br>\n";
            echo "Short Error Message: " . $ErrorShortMsg." <br>\n";
            echo "Error Code: " . $ErrorCode." <br>\n";
            echo "Error Severity Code: " . $ErrorSeverityCode." <br>\n";
        }
    
    }
    
    /*
     '-------------------------------------------------------------------------------------------------------------------------------------------
     ' Purpose:     Prepares the parameters for the SetExpressCheckout API Call.
     ' Inputs:
     '      paymentAmount:      Total value of the shopping cart
     '      currencyCodeType:   Currency code value the PayPal API
     '      paymentType:        paymentType has to be one of the following values: Sale or Order or Authorization
     '      returnURL:          the page where buyers return to after they are done with the payment review on PayPal
     '      cancelURL:          the page where buyers return to when they cancel the payment review on PayPal
     '      shipToName:     the Ship to name entered on the merchant's site
     '      shipToStreet:       the Ship to Street entered on the merchant's site
     '      shipToCity:         the Ship to City entered on the merchant's site
     '      shipToState:        the Ship to State entered on the merchant's site
     '      shipToCountryCode:  the Code for Ship to Country entered on the merchant's site
     '      shipToZip:          the Ship to ZipCode entered on the merchant's site
     '      shipToStreet2:      the Ship to Street2 entered on the merchant's site
     '      phoneNum:           the phoneNum  entered on the merchant's site
     '      email:              the buyer email
     '      desc:               Product description
     '--------------------------------------------------------------------------------------------------------------------------------------------
     */
    function callSetExpressCheckout($paymentAmount, $currencyCodeType, $paymentType, $returnURL, $cancelURL, $tag, $solutionType, $landingPage, $shipToName, $shipToStreet, $shipToCity, $shipToState, $shipToCountryCode, $shipToZip, $shipToStreet2, $phoneNum, $email='', $desc='')
    {
        //------------------------------------------------------------------------------------------------------------------------------------
        // Construct the parameter string that describes the SetExpressCheckout API call in the shortcut implementation
    
        //declaring of global variables
        global $conf, $langs;
        global $API_Endpoint, $API_Url, $API_version, $USE_PROXY, $PROXY_HOST, $PROXY_PORT;
        global $PAYPAL_API_USER, $PAYPAL_API_PASSWORD, $PAYPAL_API_SIGNATURE;
    
        $nvpstr = '';
        $nvpstr = $nvpstr . "&AMT=". urlencode($paymentAmount);                // AMT deprecated by paypal -> PAYMENTREQUEST_n_AMT
        $nvpstr = $nvpstr . "&PAYMENTACTION=" . urlencode($paymentType);       // PAYMENTACTION deprecated by paypal -> PAYMENTREQUEST_n_PAYMENTACTION
        $nvpstr = $nvpstr . "&RETURNURL=" . urlencode($returnURL);
        $nvpstr = $nvpstr . "&CANCELURL=" . urlencode($cancelURL);
        $nvpstr = $nvpstr . "&CURRENCYCODE=" . urlencode($currencyCodeType);    // CURRENCYCODE deprecated by paypal -> PAYMENTREQUEST_n_CURRENCYCODE
        $nvpstr = $nvpstr . "&ADDROVERRIDE=1";
        //$nvpstr = $nvpstr . "&ALLOWNOTE=0";
        $nvpstr = $nvpstr . "&SHIPTONAME=" . urlencode($shipToName);            // SHIPTONAME deprecated by paypal -> PAYMENTREQUEST_n_SHIPTONAME
        $nvpstr = $nvpstr . "&SHIPTOSTREET=" . urlencode($shipToStreet);        //
        $nvpstr = $nvpstr . "&SHIPTOSTREET2=" . urlencode($shipToStreet2);
        $nvpstr = $nvpstr . "&SHIPTOCITY=" . urlencode($shipToCity);
        $nvpstr = $nvpstr . "&SHIPTOSTATE=" . urlencode($shipToState);
        $nvpstr = $nvpstr . "&SHIPTOCOUNTRYCODE=" . urlencode($shipToCountryCode);
        $nvpstr = $nvpstr . "&SHIPTOZIP=" . urlencode($shipToZip);
        $nvpstr = $nvpstr . "&PHONENUM=" . urlencode($phoneNum);
        $nvpstr = $nvpstr . "&SOLUTIONTYPE=" . urlencode($solutionType);
        $nvpstr = $nvpstr . "&LANDINGPAGE=" . urlencode($landingPage);
        //$nvpstr = $nvpstr . "&CUSTOMERSERVICENUMBER=" . urlencode($tag);    // Hotline phone number
        $nvpstr = $nvpstr . "&INVNUM=" . urlencode($tag);
        if (! empty($email)) $nvpstr = $nvpstr . "&EMAIL=" . urlencode($email);
        if (! empty($desc))  $nvpstr = $nvpstr . "&DESC=" . urlencode($desc);        // DESC deprecated by paypal -> PAYMENTREQUEST_n_DESC
    
    
    	$_SESSION["Payment_Amount"] = $paymentAmount;
        $_SESSION["currencyCodeType"] = $currencyCodeType;
        $_SESSION["PaymentType"] = $paymentType;
        $_SESSION['ipaddress'] = $_SERVER['REMOTE_ADDR '];  // Payer ip
    
        //'---------------------------------------------------------------------------------------------------------------
        //' Make the API call to PayPal
        //' If the API call succeded, then redirect the buyer to PayPal to begin to authorize payment.
        //' If an error occured, show the resulting errors
        //'---------------------------------------------------------------------------------------------------------------
        $resArray=hash_call("SetExpressCheckout", $nvpstr);
        $ack = strtoupper($resArray["ACK"]);
        if($ack=="SUCCESS" || $ack=="SUCCESSWITHWARNING")
        {
            $token = urldecode($resArray["TOKEN"]);
            $_SESSION['TOKEN']=$token;
        }
    
        return $resArray;
    }
    
    /**
     * 	Prepares the parameters for the GetExpressCheckoutDetails API Call.
     *
     *	@param	string	$token		Token
     *	@return	array				The NVP Collection object of the GetExpressCheckoutDetails Call Response.
     */
    function getDetails($token)
    {
        //'--------------------------------------------------------------
        //' At this point, the buyer has completed authorizing the payment
        //' at PayPal.  The function will call PayPal to obtain the details
        //' of the authorization, incuding any shipping information of the
        //' buyer.  Remember, the authorization is not a completed transaction
        //' at this state - the buyer still needs an additional step to finalize
        //' the transaction
        //'--------------------------------------------------------------
    
        //declaring of global variables
        global $conf, $langs;
        global $API_Endpoint, $API_Url, $API_version, $USE_PROXY, $PROXY_HOST, $PROXY_PORT;
        global $PAYPAL_API_USER, $PAYPAL_API_PASSWORD, $PAYPAL_API_SIGNATURE;
    
        //'---------------------------------------------------------------------------
        //' Build a second API request to PayPal, using the token as the
        //'  ID to get the details on the payment authorization
        //'---------------------------------------------------------------------------
        $nvpstr="&TOKEN=" . $token;
    
        //'---------------------------------------------------------------------------
        //' Make the API call and store the results in an array.
        //' If the call was a success, show the authorization details, and provide
        //'     an action to complete the payment.
        //' If failed, show the error
        //'---------------------------------------------------------------------------
        $resArray=hash_call("GetExpressCheckoutDetails",$nvpstr);
        $ack = strtoupper($resArray["ACK"]);
        if($ack == "SUCCESS" || $ack=="SUCCESSWITHWARNING")
        {
            $_SESSION['payer_id'] = $resArray['PAYERID'];
        }
        return $resArray;
    }
    
    
    /**
     *	Validate payment
     *
     *	@param	string	$token				Token
     *	@param	string	$paymentType		Type
     *	@param	string	$currencyCodeType	Currency
     *	@param	string	$payerID			Payer ID
     *	@param	string	$ipaddress			IP Address
     *	@param	string	$FinalPaymentAmt	Amount
     *	@param	string	$tag				Tag
     *	@return	void
     */
    function confirmPayment($token, $paymentType, $currencyCodeType, $payerID, $ipaddress, $FinalPaymentAmt, $tag)
    {
        /* Gather the information to make the final call to
         finalize the PayPal payment.  The variable nvpstr
         holds the name value pairs
         */
    
        //declaring of global variables
        global $conf, $langs;
        global $API_Endpoint, $API_Url, $API_version, $USE_PROXY, $PROXY_HOST, $PROXY_PORT;
        global $PAYPAL_API_USER, $PAYPAL_API_PASSWORD, $PAYPAL_API_SIGNATURE;
    
        $nvpstr = '';
        $nvpstr .= '&TOKEN=' . urlencode($token);
        $nvpstr .= '&PAYERID=' . urlencode($payerID);
        $nvpstr .= '&PAYMENTACTION=' . urlencode($paymentType);
        $nvpstr .= '&AMT=' . urlencode($FinalPaymentAmt);
        $nvpstr .= '&CURRENCYCODE=' . urlencode($currencyCodeType);
        $nvpstr .= '&IPADDRESS=' . urlencode($ipaddress);
        $nvpstr .= '&INVNUM=' . urlencode($tag);
    
        /* Make the call to PayPal to finalize payment
         If an error occured, show the resulting errors
         */
        $resArray=hash_call("DoExpressCheckoutPayment",$nvpstr);
    
        /* Display the API response back to the browser.
         If the response from PayPal was a success, display the response parameters'
         If the response was an error, display the errors received using APIError.php.
         */
        $ack = strtoupper($resArray["ACK"]);
    
        return $resArray;
    }
    
    /**
     *	This function makes a DoDirectPayment API call
     *
     *  paymentType:        paymentType has to be one of the following values: Sale or Order or Authorization
     *  paymentAmount:      total value of the shopping cart
     *  currencyCode:       currency code value the PayPal API
     *  firstName:          first name as it appears on credit card
     *  lastName:           last name as it appears on credit card
     *  street:             buyer's street address line as it appears on credit card
     *  city:               buyer's city
     *  state:              buyer's state
     *  countryCode:        buyer's country code
     *  zip:                buyer's zip
     *  creditCardType:     buyer's credit card type (i.e. Visa, MasterCard ... )
     *  creditCardNumber:   buyers credit card number without any spaces, dashes or any other characters
     *  expDate:            credit card expiration date
     *  cvv2:               Card Verification Value
     *	@return		array	The NVP Collection object of the DoDirectPayment Call Response.
     */
    /*
    function DirectPayment($paymentType, $paymentAmount, $creditCardType, $creditCardNumber, $expDate, $cvv2, $firstName, $lastName, $street, $city, $state, $zip, $countryCode, $currencyCode, $tag)
    {
        //declaring of global variables
        global $conf, $langs;
        global $API_Endpoint, $API_Url, $API_version, $USE_PROXY, $PROXY_HOST, $PROXY_PORT;
        global $PAYPAL_API_USER, $PAYPAL_API_PASSWORD, $PAYPAL_API_SIGNATURE;
    
        //Construct the parameter string that describes DoDirectPayment
        $nvpstr = '';
        $nvpstr = $nvpstr . "&AMT=" . urlencode($paymentAmount);              // deprecated by paypal
        $nvpstr = $nvpstr . "&CURRENCYCODE=" . urlencode($currencyCode);
        $nvpstr = $nvpstr . "&PAYMENTACTION=" . urlencode($paymentType);      // deprecated by paypal
        $nvpstr = $nvpstr . "&CREDITCARDTYPE=" . urlencode($creditCardType);
        $nvpstr = $nvpstr . "&ACCT=" . urlencode($creditCardNumber);
        $nvpstr = $nvpstr . "&EXPDATE=" . urlencode($expDate);
        $nvpstr = $nvpstr . "&CVV2=" . urlencode($cvv2);
        $nvpstr = $nvpstr . "&FIRSTNAME=" . urlencode($firstName);
        $nvpstr = $nvpstr . "&LASTNAME=" . urlencode($lastName);
        $nvpstr = $nvpstr . "&STREET=" . urlencode($street);
        $nvpstr = $nvpstr . "&CITY=" . urlencode($city);
        $nvpstr = $nvpstr . "&STATE=" . urlencode($state);
        $nvpstr = $nvpstr . "&COUNTRYCODE=" . urlencode($countryCode);
        $nvpstr = $nvpstr . "&IPADDRESS=" . $_SERVER['REMOTE_ADDR'];
        $nvpstr = $nvpstr . "&INVNUM=" . urlencode($tag);
    
        $resArray=hash_call("DoDirectPayment", $nvpstr);
    
        return $resArray;
    }
    */
    
    
    /**
     * hash_call: Function to perform the API call to PayPal using API signature
     *
     * @param	string	$methodName 	is name of API  method.
     * @param	string	$nvpStr 		is nvp string.
     * @return	array					returns an associtive array containing the response from the server.
     */
    function hash_call($methodName,$nvpStr)
    {
        //declaring of global variables
        global $conf, $langs;
        global $API_Endpoint, $API_Url, $API_version, $USE_PROXY, $PROXY_HOST, $PROXY_PORT, $PROXY_USER, $PROXY_PASS;
        global $PAYPAL_API_USER, $PAYPAL_API_PASSWORD, $PAYPAL_API_SIGNATURE;
    
        // TODO problem with triggers
        $API_version="56";
    	if (! empty($conf->global->PAYPAL_API_SANDBOX))
    	{
    	    $API_Endpoint = "https://api-3t.sandbox.paypal.com/nvp";
    	    $API_Url = "https://www.sandbox.paypal.com/webscr?cmd=_express-checkout&token=";
    	}
    	else
    	{
    	    $API_Endpoint = "https://api-3t.paypal.com/nvp";
    	    $API_Url = "https://www.paypal.com/cgi-bin/webscr?cmd=_express-checkout&token=";
    	}
    
    	// Clean parameters
    	$PAYPAL_API_USER="";
    	if (! empty($conf->global->PAYPAL_API_USER)) $PAYPAL_API_USER=$conf->global->PAYPAL_API_USER;
    	$PAYPAL_API_PASSWORD="";
    	if (! empty($conf->global->PAYPAL_API_PASSWORD)) $PAYPAL_API_PASSWORD=$conf->global->PAYPAL_API_PASSWORD;
    	$PAYPAL_API_SIGNATURE="";
    	if (! empty($conf->global->PAYPAL_API_SIGNATURE)) $PAYPAL_API_SIGNATURE=$conf->global->PAYPAL_API_SIGNATURE;
    	$PAYPAL_API_SANDBOX="";
    	if (! empty($conf->global->PAYPAL_API_SANDBOX)) $PAYPAL_API_SANDBOX=$conf->global->PAYPAL_API_SANDBOX;
    	// TODO END problem with triggers
    
        dol_syslog("Paypal API endpoint ".$API_Endpoint);
    
        //setting the curl parameters.
        $ch = curl_init();
    
        /*print $API_Endpoint."-".$API_version."-".$PAYPAL_API_USER."-".$PAYPAL_API_PASSWORD."-".$PAYPAL_API_SIGNATURE."<br>";
         print $USE_PROXY."-".$gv_ApiErrorURL."<br>";
         print $nvpStr;
         exit;*/
        curl_setopt($ch, CURLOPT_URL, $API_Endpoint);
        curl_setopt($ch, CURLOPT_VERBOSE, 1);
        curl_setopt($ch, CURLOPT_SSLVERSION, 3); // Force SSLv3
    
        //turning off the server and peer verification(TrustManager Concept).
        curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);
        curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, FALSE);
    
        curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, empty($conf->global->MAIN_USE_CONNECT_TIMEOUT)?5:$conf->global->MAIN_USE_CONNECT_TIMEOUT);
        curl_setopt($ch, CURLOPT_TIMEOUT, empty($conf->global->MAIN_USE_RESPONSE_TIMEOUT)?30:$conf->global->MAIN_USE_RESPONSE_TIMEOUT);
    
        curl_setopt($ch, CURLOPT_RETURNTRANSFER,1);
        curl_setopt($ch, CURLOPT_POST, 1);
    
        //if USE_PROXY constant set to TRUE in Constants.php, then only proxy will be enabled.
        if ($USE_PROXY)
        {
            dol_syslog("Paypal API hash_call set proxy to ".$PROXY_HOST. ":" . $PROXY_PORT." - ".$PROXY_USER. ":" . $PROXY_PASS);
            //curl_setopt ($ch, CURLOPT_PROXYTYPE, CURLPROXY_HTTP); // Curl 7.10
            curl_setopt($ch, CURLOPT_PROXY, $PROXY_HOST. ":" . $PROXY_PORT);
            if ($PROXY_USER) curl_setopt($ch, CURLOPT_PROXYUSERPWD, $PROXY_USER. ":" . $PROXY_PASS);
        }
    
        //NVPRequest for submitting to server
        $nvpreq ="METHOD=" . urlencode($methodName) . "&VERSION=" . urlencode($API_version) . "&PWD=" . urlencode($PAYPAL_API_PASSWORD) . "&USER=" . urlencode($PAYPAL_API_USER) . "&SIGNATURE=" . urlencode($PAYPAL_API_SIGNATURE) . $nvpStr;
        $nvpreq.="&LOCALECODE=".strtoupper($langs->getDefaultLang(1));
        //$nvpreq.="&BRANDNAME=".urlencode();       // Override merchant name
        //$nvpreq.="&NOTIFYURL=".urlencode();       // For Instant Payment Notification url
    
    
        dol_syslog("Paypal API hash_call nvpreq=".$nvpreq);
    
        //setting the nvpreq as POST FIELD to curl
        curl_setopt($ch, CURLOPT_POSTFIELDS, $nvpreq);
    
        //getting response from server
        $response = curl_exec($ch);
    
        $nvpReqArray=deformatNVP($nvpreq);
        $_SESSION['nvpReqArray']=$nvpReqArray;
    
        //convrting NVPResponse to an Associative Array
        dol_syslog("Paypal API hash_call Response nvpresp=".$response);
        $nvpResArray=deformatNVP($response);
    
        if (curl_errno($ch))
        {
            // moving to display page to display curl errors
            $_SESSION['curl_error_no']=curl_errno($ch);
            $_SESSION['curl_error_msg']=curl_error($ch);
    
            //Execute the Error handling module to display errors.
        }
        else
        {
            //closing the curl
            curl_close($ch);
        }
    
        return $nvpResArray;
    }
    
    
    /**
     * This function will take NVPString and convert it to an Associative Array and it will decode the response.
     * It is usefull to search for a particular key and displaying arrays.
     *
     * @param	string	$nvpstr 		NVPString
     * @return	array					nvpArray = Associative Array
     */
    function deformatNVP($nvpstr)
    {
        $intial=0;
        $nvpArray = array();
    
        while(strlen($nvpstr))
        {
            //postion of Key
            $keypos= strpos($nvpstr,'=');
            //position of value
            $valuepos = strpos($nvpstr,'&') ? strpos($nvpstr,'&'): strlen($nvpstr);
    
            /*getting the Key and Value values and storing in a Associative Array*/
            $keyval=substr($nvpstr,$intial,$keypos);
            $valval=substr($nvpstr,$keypos+1,$valuepos-$keypos-1);
            //decoding the respose
            $nvpArray[urldecode($keyval)] =urldecode($valval);
            $nvpstr=substr($nvpstr,$valuepos+1,strlen($nvpstr));
        }
        return $nvpArray;
    }
    
    /**
     * 	Get API errors
     *
     * 	@return	array		Array of errors
     */
    function getApiError()
    {
    	$errors=array();
    
    	$resArray=$_SESSION['reshash'];
    
    	if(isset($_SESSION['curl_error_no']))
    	{
    		$errors[] = $_SESSION['curl_error_no'].'-'.$_SESSION['curl_error_msg'];
    	}
    
    	foreach($resArray as $key => $value)
    	{
    		$errors[] = $key.'-'.$value;
    	}
    
    	return $errors;
    }