Jump to content

Non-responsive PHP/XML script for EPP access

thisismatt

By thisismatt
in PHP Coding Help

 Share

Recommended Posts

thisismatt Newbie

thisismatt

Posted
Posted (edited)

I'm trying to get started with using my hosting provider's API access to their EPP. They provide certain information, which I've attempted to follow - without success!

 

For now I'm simply trying to send the greeting to the service, if I can get that going then I'll take the next steps, but something isn't working - and it here that I'm stuck.

 

<?php

require_once('api.inc');
$hi_api = new HeartInternet_API();
$hi_api->connect(false); // true = connect to the test API, false = connect to the live API.  
$username = "myUsername";
$password = "myPassword";
$hi_api->logIn($username, $password, $objects, $extensions);

$some_xml = <<<XML

<epp xmlns="urn:ietf:params:xml:ns:epp-1.0">
  <hello />
</epp> 

XML;

$returned_xml = $hi_api->sendMessage($some_xml, true);

echo "XML Sent: <br />" . htmlentities($some_xml) . "<br />";
echo "XML Received: <br /> " . htmlentities($returned_xml) . "<br />";

?>
 
The api.inc file is as follows - 
<?php
  /**
   * This provides easy access to the Heart Internet API. Please see
   * {@link http://api.heartinternet.uk/api2.html} for the API documentation
   * itself.
   * 
   * External methods:
   *
   * $hi_api->connect(bool); // true = connect to the test API, false = connect to the live API. Default is false.
   * $hi_api->logIn($username, $password, $objects, $extensions);
   * $hi_api->sendMessage($xml_to_send, bool); // true = return array, false = return XML. Default is true. 
   *
   * Usage Example:
   *
   * <code>
   * <?php
   * require_once('../HeartInternet_API.inc');
   * $hi_api = new HeartInternet_API();
   * $hi_api->connect(true); // true = connect to the test API, false = connect to the live API.  
   * $username = "your-username";
   * $password = "your-password";
   * $hi_api->logIn($username, $password, $objects, $extensions);
   * $some_xml = <<<XML
   * <?xml version="1.0"?>
   * <epp xmlns="urn:ietf:params:xml:ns:epp-1.0">
   * <command>
   * (your command)
   * </command>
   * </epp>
   * XML;
   * $returned_xml = $hi_api->sendMessage($some_xml, true);
   * echo "XML Sent: <br />" . htmlentities($some_xml) . "<br />";
   * echo "XML Received: <br /> " . htmlentities($returned_xml) . "<br />";
   * ?>
   * </code>
   *
   *
   * 
   * Recent changes:
   * 0.2: Improved fread() usage for cases where there are over 8192/16384 bytes
   *      to read.
   * 0.3: Documentation updates - example usage, methods. 
   * 0.4: Added local validation to logIn() to cover common error scenarios.
   *
   * @copyright Copyright 2011, Heart Internet Ltd
   * @version 0.5
   */
  class HeartInternet_API {
    /**
     * @var string The main API namespace
     */
    public $namespace = "urn:ietf:params:xml:ns:epp-1.0";
    private $hostname = "api.heartinternet.uk";
    /**
     * Connects to the API server and returns the greeting (as literal XML).
     *
     * @param boolean $test_mode Set to true if you want to connect to the test service instead.
     */
    public function connect($test_mode=false) {
      $this->res = fsockopen("tls://" . $this->hostname, $test_mode ? 1701 : 700);
      return $this->getResponse();
    }
    function getResponse() {
      $size_packed = fread($this->res, 4);
      if(strlen($size_packed) == 0) return;
      $size = unpack("N", $size_packed);
      // This works around PHP's fread() capping at 8192 bytes
      $out = "";
      $last = "";
      for($s = $size[1]-4; $s>0; $s-=strlen($last)) {
        $last = fread($this->res, $s);
        $out.=$last;
      }
      return $out;
    }
    /**
     * This sends an XML message to the API, and returns the result, as an
     * array by default. This will throw an exception in the case of an internal failure.
     *
     * @param string $output The XML message to send
     * @param boolean $no_parsing Set to true if you want the raw XML response returned.
     */
    public function sendMessage($output, $no_parsing=false) {
      fwrite($this->res, pack("N", strlen($output)+4) . $output);
      $content = $this->getResponse();
      
      if($content) {
        if($no_parsing) {
          return $content;
        } else {
          $result=array();
          $parser = xml_parser_create();
          xml_parser_set_option($parser, XML_OPTION_CASE_FOLDING, 0);
          xml_parser_set_option($parser, XML_OPTION_SKIP_WHITE, 1);
          xml_parse_into_struct($parser, $content, $result);
          // Do something with $result
          return $result;
        }
      } else {
        // Error handling
        throw new Exception("Communication failure");
        return;
      }
    }
    /**
     * Logs you in (once connected). Will raise an exception on failure.
     * @param string $userid Your API user ID, see the API documentation.
     * @param string $password Your API password.
     * @param array $objects The object namespaces to load. Required.
     * @param array $extensions the extension namespaces to load.
     */
    public function logIn($userid, $password, $objects, $extensions) {
      if(!preg_match('/^[a-f0-9]+$/', $userid)) {
        throw new Exception(
          "Invalid username, should look like '9cf2cdbcce5e00c0'"
        );
      }


      if( (!$objects) || empty($objects) ) {
        throw new Exception(
          "You must provide some object namespaces, please see the login examples in the documentation"
        );
      }


      $doc = new DOMDocument();
      $content          = $doc->createElement("login");
      $clID_element = $doc->createElement('clID');
      $clID_element->appendChild(
        $doc->createTextNode($userid)
      );
      $content->appendChild($clID_element);


      $pw_element = $doc->createElement('pw');
      $pw_element->appendChild(
        $doc->createTextNode($password)
      );
      $content->appendChild($pw_element);


      $options_element = $doc->createElement('options');


      $version_element = $doc->createElement('version');
      $version_element->appendChild( $doc->createTextNode("1.0"));
      $options_element->appendChild($version_element);


      $lang_element = $doc->createElement('lang');
      $lang_element->appendChild( $doc->createTextNode("en"));
      $options_element->appendChild($lang_element);


      $content->appendChild($options_element);


      $svcs_element = $doc->createElement('svcs');


      foreach($objects as $object) {
        $element = $doc->createElement('objURI');
        $element->appendChild($doc->createTextNode("$object"));
        $svcs_element->appendChild($element);
      }
   
      $svcs_extensions = $doc->createElement('svcExtension');
      foreach($extensions as $extension) {
        $element = $doc->createElement('extURI');
        $element->appendChild($doc->createTextNode("$extension"));
        $svcs_extensions->appendChild($element);
      }
      $svcs_element->appendChild($svcs_extensions);


      $content->appendChild($svcs_element);


      $xml = $this->buildXML($content);
      $result = $this->sendMessage($xml);
      // error_log($xml);
      foreach($result as $tag) {
        if(
          $tag['tag']=="result" && 
          $tag['type']!="close" && 
          $tag['attributes']['code']!=1000
        ) throw new Exception("Failed to log in!: " . $tag['attributes']['code']);


        if($tag['tag']=="session-id") return $tag['value'];
      }
      return $result;
    }
    /**
     * This transforms a DOMDocument for the inner part of the request (inside
     * <command/>) into an XML string.
     *
     * @param DOMDocument $content
     */
    public function buildXML($content) {
      $doc = $content->ownerDocument;
      $epp = $doc->createElement("epp");
      $epp->setAttribute("xmlns", $this->namespace);
      $doc->appendChild($epp);
    
      $c = $doc->createElement('command');
      $epp->appendChild($c);
      $c->appendChild($content);
    
      $output = $doc->saveXML();
      return $output;
    }
    
    /**
     * Disconnects from the API server.
     */
    public function disconnect() {
      fclose($this->res);
    }
  }
?>
 
Can anyone work out why this doesn't work? Apologies in advance if this is really simple, but thanks!

 

Edited by thisismatt
Link to comment
Share on other sites
thisismatt Newbie

thisismatt

Posted
  • Author
Posted

1, No, I'm not. I'm using test system logins.

 

2, What tells me that? Previously, 500 errors. Now it is this - 

 

 

Notice: Undefined variable: objects in /home/sites/thisismatt.co.uk/public_html/epp/phptest.php on line 11 Notice: Undefined variable: extensions in /home/sites/thisismatt.co.uk/public_html/epp/phptest.php on line 11 Fatal error: Uncaught exception 'Exception' with message 'You must provide some object namespaces, please see the login examples in the documentation' in /home/sites/thisismatt.co.uk/public_html/epp/api.php:124 Stack trace: #0 /home/sites/thisismatt.co.uk/public_html/epp/phptest.php(11): HeartInternet_API->logIn('87bd83a452af36b...', '2ebe5fb90', NULL, NULL) #1 {main} thrown in /home/sites/thisismatt.co.uk/public_html/epp/api.php on line 124

 

3, I didn't, but do now (hence above).

 

I'm wholly new to php, so for this I am being guided by what little information is available on Heart's API page - http://api.heartinternet.co.uk/api2.html

Link to comment
Share on other sites
ginerjm Prolific Member

ginerjm

Posted
Posted

To avoid possibly getting flagged by your target you mishgt want to use the test api instead of the live one. Just my $.02

 

Obviously you have some cleanup to do with all those errors. This is not merely a PHP problem but one that needs to be worked out with the "Heart" people/documentation.

 

Have you defined $objects & $extensions?

Link to comment
Share on other sites
thisismatt Newbie

thisismatt

Posted
  • Author
Posted

I've checked my code and I am indeed using the test api, I think I'd been careless in my copying above :-/  Thanks for flagging.

 

Unfortunately Heart don't provide any support for these examples, hence me seeking assistance from this community. I'm keen to learn and develop my skills, but without even knowing where to start here is somewhat frustrating.

 

As for $objects and $extensions, the quick answer is no, I wasn't aware I needed to. I pretty much took as read what the examples on Heart's pages stated, that sending the EPP greeting "Hello" should receive a response as below -

<?xml version="1.0" encoding="utf-8"?>
<epp xmlns="urn:ietf:params:xml:ns:epp-1.0">
  <greeting>
    <svID>Heart Internet Test API Server</svID>
    <svDate>2010-08-17T12:34:53Z</svDate>
    <svcMenu>
      <version>1.0</version>
      <lang>en-GB</lang>
      <objURI>urn:ietf:params:xml:ns:contact-1.0</objURI>
      <objURI>urn:ietf:params:xml:ns:domain-1.0</objURI>
      <objURI>http://www.heartinternet.co.uk/whapi/database-2.0</objURI>
      <objURI>http://www.heartinternet.co.uk/whapi/mailbox-2.0</objURI>
      <objURI>http://www.heartinternet.co.uk/whapi/null-2.0</objURI>
      <objURI>http://www.heartinternet.co.uk/whapi/package-2.2</objURI>
      <objURI>http://www.heartinternet.co.uk/whapi/server-2.2</objURI>
      <objURI>http://www.heartinternet.co.uk/whapi/support-2.0</objURI>
      <svcExtension>
        <extURI>http://www.heartinternet.co.uk/whapi/ext-antivirus-2.0</extURI>
        <extURI>http://www.heartinternet.co.uk/whapi/ext-billing-2.0</extURI>
        <extURI>http://www.heartinternet.co.uk/whapi/ext-database-2.0</extURI>
        <extURI>http://www.heartinternet.co.uk/whapi/ext-dns-2.0</extURI>
        <extURI>http://www.heartinternet.co.uk/whapi/ext-domain-2.5</extURI>
        <extURI>http://www.heartinternet.co.uk/whapi/ext-contact-2.0</extURI>
        <extURI>http://www.heartinternet.co.uk/whapi/ext-mailbox-2.0</extURI>
        <extURI>http://www.heartinternet.co.uk/whapi/ext-host-2.0</extURI>
        <extURI>http://www.heartinternet.co.uk/whapi/ext-null-2.0</extURI>
        <extURI>http://www.heartinternet.co.uk/whapi/ext-package-2.2</extURI>
        <extURI>http://www.heartinternet.co.uk/whapi/ext-security-2.0</extURI>
        <extURI>http://www.heartinternet.co.uk/whapi/ext-server-2.2</extURI>
        <extURI>http://www.heartinternet.co.uk/whapi/ext-support-2.0</extURI>
        <extURI>http://www.heartinternet.co.uk/whapi/ext-wbp-2.0</extURI>
        <extURI>http://www.heartinternet.co.uk/whapi/ext-whapi-2.0</extURI>
      </svcExtension>
    </svcMenu>
    <dcp>
      <access>
        <all />
      </access>
      <statement>
        <purpose>
          <admin />
          <prov />
        </purpose>
        <recipient>
          <ours />
        </recipient>
        <retention>
          <indefinite />
        </retention>
      </statement>
    </dcp>
  </greeting>
</epp>

Whilst I'm not necessarily asking you/someone to do everything for me, a helping hand in working out where I'm going wrong would be massively appreciated.

Link to comment
Share on other sites
  • 4 months later...
macroman Newbie

macroman

Posted
Posted (edited)

Define the following before you login and you should be fine:

$objects = array(
    "http://www.heartinternet.co.uk/whapi/database-2.0",
    "http://www.heartinternet.co.uk/whapi/mailbox-2.0",
    "http://www.heartinternet.co.uk/whapi/offsite-package-2.2",
    "http://www.heartinternet.co.uk/whapi/package-2.2",
    "http://www.heartinternet.co.uk/whapi/server-2.2",
    "http://www.heartinternet.co.uk/whapi/support-2.0"
);

$extensions= array(
    "http://www.heartinternet.co.uk/whapi/ext-antivirus-2.0",
    "http://www.heartinternet.co.uk/whapi/ext-billing-2.0",
    "http://www.heartinternet.co.uk/whapi/ext-database-2.0",
    "http://www.heartinternet.co.uk/whapi/ext-dns-2.0",
    "http://www.heartinternet.co.uk/whapi/ext-mailbox-2.0",
    "http://www.heartinternet.co.uk/whapi/ext-offsite-package-2.2",
    "http://www.heartinternet.co.uk/whapi/ext-package-2.2",
    "http://www.heartinternet.co.uk/whapi/ext-security-2.0",
    "http://www.heartinternet.co.uk/whapi/ext-server-2.2",
    "http://www.heartinternet.co.uk/whapi/ext-support-2.0",
    "http://www.heartinternet.co.uk/whapi/ext-wbp-2.0",
    "http://www.heartinternet.co.uk/whapi/ext-whapi-2.0"
);

Heart's examples are pretty comprehensive but you have to work them a bit sometimes.

 

Have fun :)

 

Mike

Edited by macroman
Link to comment
Share on other sites
This thread is more than a year old. Please don't revive it unless you have something important to add.

Join the conversation

You can post now and register later. If you have an account, sign in now to post with your account.

Guest
Reply to this topic...

×   Pasted as rich text.   Restore formatting

  Only 75 emoji are allowed.

×   Your link has been automatically embedded.   Display as a link instead

×   Your previous content has been restored.   Clear editor

×   You cannot paste images directly. Upload or insert images from URL.

×
 Share
Go to topic listing
×
×
  • Create New...

Important Information

We have placed cookies on your device to help make this website better. You can adjust your cookie settings, otherwise we'll assume you're okay to continue.