root/apps/php/trunk/Telhosting_Client.php

#!/opt/local/bin/php -q
<?php

/**
 * @author Pierre Clisson <clisson.tel>
 * modified by Henri Asseily <henri.tel>
 * modified by Swen Wojciechowski <swen.tel>
 * modified by Mark Kolb <kprobe.tel>
 *
 * INSTRUCTIONS: PLEASE READ CAREFULLY
 *
 * 1.   Download the client WSDL from YOUR registrar, save it in the same directory as this file
 *      and name the downloaded file: client.wsdl
 * 
 * 1.5  Don't know where your registrar put the WSDL file? Open an command-line client on UNIX
 *      and write:  dig _soap._nspapi.yourdomain.tel naptr
 *      where you replace yourdomain with your actual domain. Then take either the http or https
 *      url and append to it "?wsdl" (so it will end in "...client?wsdl")
 *      That's the url for your registrar's WSDL file.
 *
 * 2.   Edit client.wsdl -- find the string: "http://www.w3.org/2003/05/soap/bindings/HTTP/" and
 *      replace it by: "http://schemas.xmlsoap.org/soap/http". If you don't do that, PHP will
 *      throw a fatal error: "SOAP-ERROR: Parsing WSDL: PHP-SOAP doesn't support transport
 *      'http://www.w3.org/2003/05/soap/bindings/HTTP/'".
 *
 * 3.   Do *not* edit this file by correcting $config['login'] and $config['password']
 *      if login credentials are specified in another php file which uses this file
 *      (i.e. sample_client.php or sample_create_mx.php)
 *
 * Enjoy.
 *
 */

class Telhosting_Client {

        /**
         * @var object the SOAP Client object, once connected
         */
        var $soap_client;
        
        /**
         * @var array the config array
         */
        var $config;
        
        /**
         * @var string last SOAP error
         */
        var $last_soap_error;
        
        /**
         * Constructor
         */
        function __construct($config) {
                // Store config
                $this->config = $config;
                // Do not cache WSDL. Comment this line in production environment
                ini_set("soap.wsdl_cache_enabled", "0");
                // Connect to the SOAP server
                return $this->soap_connect();
        }
        
        /**
         * Connect to the SOAP server
         *
         * @return bool
         */
        function soap_connect() {
                $options = array( 
                        'soap_version' => SOAP_1_2,
                        'encoding' => 'UTF-8',
                        'login' => $this->config['login'],
                        'password' => $this->config['password'],
     // 'trace' => true,
                        'exceptions' => 0
                );
                try {
                        $this->soap_client = new SoapClient($this->config['wsdl'], $options);
                } catch (SoapFault $fault) {
                        return FALSE;
                }
                return TRUE;
        }
        
        /**
         * A very basic logging system
         *
         * @param string $type
         * @param string $message
         */
        function log_message($type, $message) {
                if ($type == 'soap') {
                        $this->last_soap_error = $message;
                }
                echo "$message\n";
        }
        
        /**
         * Keyword constructor
   *
   * @param string $f : field name
   * @param string $v : value
   * @param array $k  : array of secondary keywords
         */
  function new_keyword($f, $v, $k = NULL) {
    $self = new stdClass();
    $self->field = $f;
    $self->value = $v;
    if ($k != NULL) {
      $self->keyword = $k;
    }
    return $self;
  }


        /**
         * List all methdods
         */
        function list_methods() {
                $response = $this->soap_client->__getFunctions();
                if (is_soap_fault($response)) {
                        $this->log_message('soap', "SOAP Fault: (faultcode: {". $response->faultcode ."}, faultstring: {".$response->faultstring."})");
                        return FALSE;
                } else {
                        return $response;
                }
        }
        
        /**
         * List domains
         */
        function list_domains() {
                $response = $this->soap_client->listDomains();
                if (is_soap_fault($response)) {
                        $this->log_message('soap', "SOAP Fault: (faultcode: {". $response->faultcode ."}, faultstring: {".$response->faultstring."})");
                        return FALSE;
                } else {
                        return $response;
                }
        }

  /**
   * Get a Specific Domain's Information (DDS Title, etc...)
   *
   * @param string $domain
   */
  function get_domain($domain) {
    $params = array('domainName' => $domain, 'effUserName' => '');
    $response = $this->soap_client->getDomain($params);
    if (is_soap_fault($response)) {
      $this->log_message('soap', "SOAP Fault: (faultcode: {". $response->faultcode ."}, faultstring: {".$response->faultstring."})");
      return FALSE;
    } else {
      return $response;
    }
  }

  /**
   * Update Domain Information (Title, etc...)
   *
   * @param string $domain
   * @param string $title DDS tile
   */
  function update_domain($domain,$title) {
    $params = array('domainName' => $domain, 'displayString' => $title);
    $response = $this->soap_client->updateDomain($params);
    if (is_soap_fault($response)) {
      $this->log_message('soap', "SOAP Fault: (faultcode: {". $response->faultcode ."}, faultstring: {".$response->faultstring."})");
      return FALSE;
    } else {
      return $response;
    }
  }

        /**
         * Create domain
         * Note that this method does NOT create a link to the newly created subdomain
   * You need to explicitly call store_record() and create a non-terminal NAPTR to point to it
   *
         * @param string $domain
         */
        function create_domain($domain) {
                $params = array('domainName' => $domain);
                $response = $this->soap_client->createDomain($params);
                if (is_soap_fault($response)) {
                        $this->log_message('soap', "SOAP Fault: (faultcode: {". $response->faultcode ."}, faultstring: {".$response->faultstring."})");
                        return FALSE;
                } else {
                        return $response;
                }
        }

        /**
         * Delete domain
   *
         * @param string $domain
         */
        function delete_domain($domain) {
                $params = array('domainName' => $domain);
                $response = $this->soap_client->deleteDomain($params);
                if (is_soap_fault($response)) {
                        $this->log_message('soap', "SOAP Fault: (faultcode: {". $response->faultcode ."}, faultstring: {".$response->faultstring."})");
                        return FALSE;
                } else {
                        return $response;
                }
        }

        /**
         * List profiles
         *
         * @param string $domain
         */
        function list_profiles($domain) {
                $params = array('domainName' => $domain);
                $response = $this->soap_client->listProfiles($params);
                if (is_soap_fault($response)) {
                        $this->log_message('soap', "SOAP Fault: (faultcode: {". $response->faultcode ."}, faultstring: {".$response->faultstring."})");
                        return FALSE;
                } else {
                        return $response;
                }
        }


        /**
         * get active profile
         *
         * @param string $domain
         */
        function get_active_profile($domain) {
                $params = array('domainName' => $domain);
                $response = $this->soap_client->getActiveProfile($params);
                if (is_soap_fault($response)) {
                        $this->log_message('soap', "SOAP Fault: (faultcode: {". $response->faultcode ."}, faultstring: {".$response->faultstring."})");
                        return FALSE;
                } else {
                        return $response;
                }
        }


        /**
         * List records
         *
         * @param string $domain
         */
        function list_records($domain) {
                $params = array('domainName' => $domain);
                $response = $this->soap_client->listRecords($params);
                if (is_soap_fault($response)) {
                        $this->log_message('soap', "SOAP Fault: (faultcode: {". $response->faultcode ."}, faultstring: {".$response->faultstring."})");
                        return FALSE;
                } else {
                        return $response;
                }
        }
        
        /**
         * Delete a record
         *
         * @param string $domain
         * @param int $id
         */
        function delete_record($domain, $id) {
                $params = array(
                        'domainName' => $domain,
                        'id' => $id
                );
                $response = $this->soap_client->deleteRecord($params);
                if (is_soap_fault($response)) {
                        $this->log_message('soap', "SOAP Fault: (faultcode: {". $response->faultcode ."}, faultstring: {".$response->faultstring."})");
                        return FALSE;
                } else {
                        return $response;
                }
        }
        
        /**
         * Insert a record
         *
         * @param string $domain
         * @param string $type txt or naptr
         * @param array $data
         */
        function store_record($domain, $type, $data) {
                $params = array(
                        'domainName' => $domain,
                        $type => $data
                );
                $response = $this->soap_client->storeRecord($params);
                if (is_soap_fault($response)) {
                        $this->log_message('soap', "SOAP Fault: (faultcode: {". $response->faultcode ."}, faultstring: {".$response->faultstring."})");
                        return FALSE;
                } else {
                        return $response;
                }       
        }

  // Keyword management

        /**
         * List keywords
         *
         * @param string $domain
         */
        function get_search_data($domain) {
                $params = array('domainName' => $domain);
                $response = $this->soap_client->getSearchData($params);
                if (is_soap_fault($response)) {
                        $this->log_message('soap', "SOAP Fault: (faultcode: {". $response->faultcode ."}, faultstring: {".$response->faultstring."})");
                        return FALSE;
                } else {
                        return $response;
                }
        }

  function keyword_to_string($k) {
    $s = $k->field . ': ' . $k->value;
    if (isset($k->keyword)) {
      foreach($k->keyword as $value) {
        $s = $s . ' - ' . $this->keyword_to_string($value);
      }
    }
    return $s;
  }
        /**
         * Replace ALL keywords
         *
         * @param string $domain
         * @param array $data
   * @param bool $removeDuplicates
   *
   * inside $data: an array of all keywords
   * Set $removeDuplicates to FALSE to disable removal of duplicate keywords
   * $removeDuplicates is set to TRUE by default
         */
        function set_search_data($domain, $data, $removeDuplicates = TRUE) {
    if ($removeDuplicates) {
      $unik = array();
      foreach($data->keyword as $value) {
        $ks = $this->keyword_to_string($value);
        if (isset($unik[$ks])) {
          continue;
        }
        $unik[$ks] = 1;
        $newkeyword[] = $value;
      }
      $data->keyword = $newkeyword;
    }
                $params = array(
                        'domainName' => $domain,
                        'searchData' => $data
                );
                $response = $this->soap_client->setSearchData($params);
                if (is_soap_fault($response)) {
                        $this->log_message('soap', "SOAP Fault: (faultcode: {". $response->faultcode ."}, faultstring: {".$response->faultstring."})");
                        return FALSE;
                } else {
                        return $response;
                }       
        }


        /**
         * Export Data
         *
         * @param array $domains
         * @param array $zones
         */
        function export_data($domains = '', $zones = '') {
    $params = array();
    if ($domains != '') {
      $params['domains'] = $domains;
    }
    if ($zones != '') {
      $params['zones'] = $zones;
    }
                $response = $this->soap_client->exportData($params);
                if (is_soap_fault($response)) {
                        $this->log_message('soap', "SOAP Fault: (faultcode: {". $response->faultcode ."}, faultstring: {".$response->faultstring."})");
                        return FALSE;
                } else {
                        return $response;
                }
        }


        /**
         * Import Data
         *
         * @param array $domains
         * @param array $zones
         * @param array $data
         */
        function import_data($domains = '', $zones = '', $data = '', $overwrite = TRUE) {
    $params = array(
        'overwrite' => $overwrite,
        'data' => $data
        );
    if ($domains != '') {
      $params['domains'] = $domains;
    }
    if ($zones != '') {
      $params['zones'] = $zones;
    }
                $response = $this->soap_client->importData($params);
                if (is_soap_fault($response)) {
                        $this->log_message('soap', "SOAP Fault: (faultcode: {". $response->faultcode ."}, faultstring: {".$response->faultstring."})");
                        return FALSE;
                } else {
                        return $response;
                }
        }
}
?>