Namesilo.php

<?php
/*

Namesilo Registrar Module 
Contributor: lukapaunovic

Changelog:
2.20.2017 - Payment ID
04.14.2018 - Domain Renewal Bug Fix
*/
class Registrar_Adapter_Namesilo extends Registrar_AdapterAbstract
{
    public $config = array(
        'apikey' => null,
		'Payment_ID' => null
    );
    public function __construct($options)
    {
        if (!extension_loaded('curl')) {
            throw new Registrar_Exception('CURL extension is not enabled');
        }
        if(isset($options['apikey']) && !empty($options['apikey'])) {
            $this->config['apikey'] = $options['apikey'];
            unset($options['apikey']);
        } else {
            throw new Registrar_Exception('Domain registrar "Namesilo" is not configured properly. Please update configuration parameter "Namesilo Apikey" at "Configuration -> Domain registration".');
        }
		
        if(isset($options['Payment_ID']) && !empty($options['Payment_ID'])) {
            $this->config['Payment_ID'] = $options['Payment_ID'];
            unset($options['Payment_ID']);
        }
    }
    public static function getConfig()
    {
        return array(
            'label' => 'Manages domains on Namesilo via API',
            'form'  => array(
                'apikey' => array('password', array(
                    'label' => 'Namesilo API key',
                    'description'=>'Namesilo API key',
                    'renderPassword' => true,
                ),
            ),
                'Payment_ID' => array('Payment_ID', array(
                    'label' => 'Payment ID',
                    'description'=>'Payment ID',
                    'required'=> false,
                ),
            ),
            ),
        );
    }

    public function getTlds()
    {
        return array(
            '.com', '.net', '.org', '.biz', '.info', '.mobi', '.us', '.me', '.co'
        );
    }

    /**
     * @param Registrar_Domain $domain
     * @return bool
     * @throws Registrar_Exception
     * @see https://www.namesilo.com/api_reference.php#checkRegisterAvailability
     */
    public function isDomainAvailable(Registrar_Domain $domain)
    {
        $params = array(
            'domains' => $domain->getName(),
        );

        $result = $this->_request('checkRegisterAvailability', $params);

        return (isset($result->reply->available)
            && ($result->reply->available->domain == $domain->getName()));
    }

    /**
     * @param Registrar_Domain $domain
     * @return bool
     * @throws Registrar_Exception
     * @see https://www.namesilo.com/api_reference.php#changeNameServers
     */
    public function modifyNs(Registrar_Domain $domain)
    {
        $params = array(
            'domain' => $domain->getName(),
        );

        $params['ns1'] = $domain->getNs1();
        $params['ns2'] = $domain->getNs2();
        if($domain->getNs3())  {
            $params['ns3'] = $domain->getNs3();
        }
        if($domain->getNs4())  {
            $params['ns4'] = $domain->getNs4();
        }

        $this->_request('changeNameServers', $params);

        return true;
    }

    /**
     * @param Registrar_Domain $domain
     * @return bool
     * @throws Registrar_Exception
     * @see https://www.namesilo.com/api_reference.php#getDomainInfo
     * @see https://www.namesilo.com/api_reference.php#contactUpdate
     */
    public function modifyContact(Registrar_Domain $domain)
    {
        $c = $domain->getContactRegistrar();

        $params = array(
            'domain' => $domain->getName(),
        );

        $result = $this->_request('getDomainInfo', $params);

        $params = array(
            'contact_id' => (string) $result->reply->contact_ids->registrant,

            'fn' => $c->getFirstName(),
            'ln' => $c->getLastName(),
            'ad' => $c->getAddress1(),
            'ad2' => $c->getAddress2(),
            'cy' => $c->getCity(),
            'st' => $c->getState(),
            'zp' => $c->getZip(),
            'ct' => $c->getCountry(),
            'em' => $c->getEmail(),
            'ph' => $c->getTel(),
        );

        $this->_request('contactUpdate', $params);

        return true;
    }

    /**
     * @param Registrar_Domain $domain
     * @return bool
     * @throws Registrar_Exception
     * @see https://www.namesilo.com/api_reference.php#transferDomain
     */
    public function transferDomain(Registrar_Domain $domain)
    {
        $params = array(
            'domain' => $domain->getName(),
            'auth' => $domain->getEpp(),
        );

        if ($domain->getName() == '.us'){
            $params['usnc'] = 'C12';
            $params['usap'] = 'P3';
        }

        $c = $domain->getContactRegistrar();
        $params['fn'] = $c->getFirstName();
        $params['ln'] = $c->getLastName();
        $params['ad'] = $c->getAddress1();
        $params['ad2'] = $c->getAddress2();
        $params['cy'] = $c->getCity();
        $params['st'] = $c->getState();
        $params['zp'] = $c->getZip();
        $params['ct'] = $c->getCountry();
        $params['em'] = $c->getEmail();
        $params['ph'] = $c->getTel();

        $this->_request('transferDomain', $params);
        return true;
    }

    /**
     * @param Registrar_Domain $domain
     * @return Registrar_Domain
     * @throws Registrar_Exception
     * @see https://www.namesilo.com/api_reference.php#getDomainInfo
     * @see https://www.namesilo.com/api_reference.php#contactList
     */
    public function getDomainDetails(Registrar_Domain $domain)
    {
        $params = array(
            'domain' => $domain->getName(),
        );

        $result = $this->_request('getDomainInfo', $params);
        $result = $result->reply;

        $params = array(
            'contact_id' => (string) $result->contact_ids->registrant,
        );

        $contact = $this->_request('contactList', $params);
        $contact = $contact->reply->contact;

        $c = new Registrar_Domain_Contact();
        $c->setFirstName((string) $contact->first_name)
            ->setLastName((string) $contact->last_name)
            ->setEmail((string) $contact->email)
            ->setCompany((string) $contact->company)
            ->setTel((string) $contact->phone)
            ->setAddress1((string) $contact->address)
            ->setAddress2((string) $contact->address2)
            ->setCity((string) $contact->city)
            ->setCountry((string) $contact->country)
            ->setZip((string) $contact->zip);
        // Add nameservers
        $i = 1;
        foreach ($result->nameservers->nameserver as $ns)
        {
            if ($i == 1){
                $domain->setNs1((string) $ns);
            }
            if ($i == 2){
                $domain->setNs2((string) $ns);
            }
            if ($i == 3){
                $domain->setNs3((string) $ns);
            }
            if ($i == 4){
                $domain->setNs4((string) $ns);
            }
            $i++;
        }
        $privacy = false;
        if ((string) $result->private == 'Yes')
            $privacy = true;

        $domain->setExpirationTime(strtotime($result->expires));
        $domain->setRegistrationTime(strtotime($result->created));
        $domain->setPrivacyEnabled($privacy);
        //$domain->setEpp();
        $domain->setContactRegistrar($c);

        return $domain;

    }

    /**
     * @param Registrar_Domain $domain
     * @throws Registrar_Exception
     */
    public function deleteDomain(Registrar_Domain $domain)
    {
        throw new Registrar_Exception('Registrar does not support domain removal.');
    }
    /**
     * @param Registrar_Domain $domain
     * @return bool
     * @throws Registrar_Exception
     * @see https://www.namesilo.com/api_reference.php#registerDomain
     */
    public function registerDomain(Registrar_Domain $domain)
    {
        $c = $domain->getContactRegistrar();

        $params = array(
            'domain' => $domain->getName(),
            'years' => $domain->getRegistrationPeriod(),          

            'fn' => $c->getFirstName(),
            'ln' => $c->getLastName(),
            'ad' => $c->getAddress1(),
            'ad2' => $c->getAddress2(),
            'cy' => $c->getCity(),
            'st' => $c->getState(),
            'zp' => $c->getZip(),
            'ct' => $c->getCountry(),
            'em' => $c->getEmail(),
            'ph' => $c->getTel(),
        );

        if ($domain->getName() == '.us'){
            $params['usnc'] = 'C12';
            $params['usap'] = 'P3';
        }

        $params['ns1'] = $domain->getNs1();
        $params['ns2'] = $domain->getNs2();
        if($domain->getNs3())  {
            $params['ns3'] = $domain->getNs3();
        }
        if($domain->getNs4())  {
            $params['ns4'] = $domain->getNs4();
        }
        $result = $this->_request('registerDomain', $params);

        return true;
    }

    /**
     * @param Registrar_Domain $domain
     * @return bool
     * @throws Registrar_Exception
     * @see https://www.namesilo.com/api_reference.php#renewDomain
     */
    public function renewDomain(Registrar_Domain $domain)
    {
        $params = array(
            'domain' => $domain->getName(),
            'years' => $domain->getRegistrationPeriod(),
        );

        $this->_request('renewDomain', $params);
        return true;
    }

    /**
     * @param Registrar_Domain $domain
     * @return bool
     * @throws Registrar_Exception
     * @see https://www.namesilo.com/api_reference.php#removePrivacy
     * @see https://www.namesilo.com/api_reference.php#addPrivacy
     */
    public function togglePrivacyProtection(Registrar_Domain $domain)
    {
        $params = array(
            'domain' => $domain->getName(),
        );

        $result = $this->_request('getDomainInfo', $params);

        $cmd = 'removePrivacy';
        if ((string) $result->reply->private == 'No')
            $cmd = 'addPrivacy';

        $this->_request($cmd, $params);
        return true;
    }

    /**
     * @param Registrar_Domain $domain
     * @return bool
     * @throws Registrar_Exception
     * @see https://www.namesilo.com/api_reference.php#checkTransferAvailability
     */
    public function isDomainCanBeTransfered(Registrar_Domain $domain)
    {
        $params = array(
            'domains' => $domain->getName(),
        );

        $result = $this->_request('checkTransferAvailability', $params);

        return (isset($result->reply->available)
            && ($result->reply->available->domain == $domain->getName()));
    }

    /**
     * @param Registrar_Domain $domain
     * @return bool
     * @throws Registrar_Exception
     * @see https://www.namesilo.com/api_reference.php#domainLock
     */
    public function lock(Registrar_Domain $domain)
    {
        $params = array(
            'domain' => $domain->getName(),
        );

        $result = $this->_request('domainLock', $params);
        return true;
    }

    /**
     * @param Registrar_Domain $domain
     * @return bool
     * @throws Registrar_Exception
     * @see https://www.namesilo.com/api_reference.php#domainUnlock
     */
    public function unlock(Registrar_Domain $domain)
    {
        $params = array(
            'domain' => $domain->getName(),
        );

        $result = $this->_request('domainUnlock', $params);
        return true;
    }

    /**
     * @param Registrar_Domain $domain
     * @return bool
     * @throws Registrar_Exception
     * @see https://www.namesilo.com/api_reference.php#addPrivacy
     */
    public function enablePrivacyProtection(Registrar_Domain $domain)
    {
        $params = array(
            'domain' => $domain->getName(),
        );

        $result = $this->_request('addPrivacy', $params);
        return true;
    }

    /**
     * @param Registrar_Domain $domain
     * @return bool
     * @throws Registrar_Exception
     * @see https://www.namesilo.com/api_reference.php#removePrivacy
     */
    public function disablePrivacyProtection(Registrar_Domain $domain)
    {
        $params = array(
            'domain' => $domain->getName(),
        );

        $result = $this->_request('removePrivacy', $params);
        return true;
    }

    /**
     * @param Registrar_Domain $domain
     * @return bool
     * @throws Registrar_Exception
     * @see https://www.namesilo.com/api_reference.php#retrieveAuthCode
     */
    public function getEpp(Registrar_Domain $domain)
    {
        $params = array(
            'domain' => $domain->getName(),
        );

        $result = $this->_request('retrieveAuthCode', $params);
        return 'EPP transfer code for the domain emailed to the administrative contact';
    }
    /**
     * Runs an api command and returns parsed data.
     * @param string $cmd
     * @param array $params
     * @return array
     */
    private function _request($cmd, $params)
    {
        $params['version'] = 1;
        $params['type'] = 'xml';
        $params['key'] = $this->config['apikey'];
        $params['payment_id'] = $this->config['Payment_ID'];

        $query = http_build_query($params);

        $curl_opts = array(
            CURLOPT_URL => $this->_getApiUrl() . $cmd . '?' . $query,
            CURLOPT_SSL_VERIFYHOST => 0,
            CURLOPT_SSL_VERIFYPEER => 0,
            CURLOPT_RETURNTRANSFER => 1,
            CURLOPT_FOLLOWLOCATION => 1,
        );

        $ch = curl_init();
        curl_setopt_array($ch, $curl_opts);

        $result = curl_exec($ch);

        if ($result === false) {
            $e = new Registrar_Exception(sprintf('CurlException: "%s"', curl_error($ch)));
            $this->getLog()->err($e);
            curl_close($ch);
            throw $e;
        }
        curl_close($ch);

        $this->getLog()->debug($this->_getApiUrl() . $cmd . '?' . $query);
        $this->getLog()->debug(print_r($result, true));
        try {
            $xml = new SimpleXMLElement($result);
        } catch (Exception $e) {
            throw new Registrar_Exception($e->getMessage());
        }

        if ($xml->reply->code != 300)
            throw new Registrar_Exception($xml->reply->detail);

        return $xml;
    }

    public function isTestEnv()
    {
        return $this->_testMode;
    }
    /**
     * Api URL.
     * @return string
     */
    private function _getApiUrl()
    {
        if ($this->isTestEnv())
            return 'http://sandbox.namesilo.com/api/';
        return 'https://www.namesilo.com/api/';
    }
}