fix: GET params not correctly send

Daandeve · Daandeve · commit 3ed86e2d209f · 2024-12-04T18:50:10.000+01:00
fix: 'billing_handle' missing from domain actions

fix: Domain details datetime incorrect format

feat: All domain details now fetched
diff --git a/README.md b/README.md
@@ -1,2 +1,71 @@
-# fossbilling-registrar-openprovider
- 
+# OpenProvider Integration for FOSSBilling
+
+This project integrates the OpenProvider domain registrar with FOSSBilling, enabling users to manage domain registration, transfer, and renewal directly from their FOSSBilling platform.
+
+---
+
+## Features
+
+- **Domain Registration**: Register new domains using OpenProvider's API.
+- **Domain Transfer**: Transfer existing domains to OpenProvider from FOSSBilling.
+- **Domain Management**: Update DNS, WHOIS, and other settings directly.
+- **Renewals**: Automate domain renewals through OpenProvider.
+
+---
+
+## Requirements
+
+- **FOSSBilling**: Make sure you have FOSSBilling installed and properly configured.
+- **OpenProvider Account**: An active account with OpenProvider is required to use their API.
+
+---
+
+## Installation
+
+1. Clone this repository and copy the files to the root of your FOSSBilling installation:
+   ```bash
+   git clone https://github.com/Devife/fossbilling-registrar-openprovider.git
+   ```
+1. Navigate to the FOSSBilling admin panel.
+
+1. Go to System > Domain registration > New domain registrar and enable the OpenProvider module.
+
+1. Refresh the page, go to the Registrars tab and edit the OpenProvider settings
+
+1. Enter your OpenProvider API credentials:
+   - API URL: Live https://api.openprovider.eu (Sandbox http://api.sandbox.openprovider.nl:8480)
+   - Username
+   - Password
+1. Save your configuration.
+
+## Usage
+
+1. Add OpenProvider as your registrar for specific TLDs in FOSSBilling.
+
+1. Clients can register, transfer, or renew domains through your billing system, and the integration will communicate with OpenProvider's API to process requests.
+
+1. Monitor and manage domain actions directly from your FOSSBilling admin panel.
+
+## Troubleshooting
+
+- Connection Issues: Ensure your server can connect to the OpenProvider API endpoint.
+- API Errors: Double-check your credentials and ensure your OpenProvider account has sufficient privileges.
+- PHP Errors: Verify if your PHP version is supported by FOSSBilling.
+
+## Contributing
+
+Contributions are welcome! Please follow these steps:
+
+1. Fork the repository.
+1. Create a new branch (feature/your-feature).
+1. Commit your changes.
+1. Open a pull request with a detailed description.
+
+## License
+
+This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
+
+## Acknowledgments
+
+1. OpenProvider for their robust API.
+1. FOSSBilling for their open-source billing platform.
diff --git a/library/Registrar/Adapter/OpenProvider.php b/library/Registrar/Adapter/OpenProvider.php
@@ -23,7 +23,6 @@ class Registrar_Adapter_OpenProvider extends Registrar_AdapterAbstract
     );
 
     private const MODULE_VERSION = "0.1";
-    private const PATH_LOG = "./library/Registrar/Adapter";
     private const DIR_LOG = "logs";
     private const FILE_LOG = "openprovider.log";
 
@@ -33,21 +32,21 @@ public function __construct($options)
             $this->config['Username'] = $options['Username'];
             unset($options['Username']);
         } else {
-            throw new Registrar_Exception('OpenProvider Registrar module error.<br>Please update configuration parameter "Reseller Username" at "Configuration -> Domain registration"');
+            throw new Registrar_Exception('OpenProvider Registrar module error. Please update configuration parameter "Reseller Username" at "Configuration -> Domain registration"', [':domain_registrar' => 'OpenProvider', ':missing' => 'OpenProvider Username'], 3001);
         }
 
         if (isset($options['Password']) && !empty($options['Password'])) {
             $this->config['Password'] = $options['Password'];
             unset($options['Password']);
         } else {
-            throw new Registrar_Exception('OpenProvider Registrar module error.<br>Please update configuration parameter "Reseller Password" at "Configuration -> Domain registration"');
+            throw new Registrar_Exception('OpenProvider Registrar module error. Please update configuration parameter "Reseller Password" at "Configuration -> Domain registration"', [':domain_registrar' => 'OpenProvider', ':missing' => 'OpenProvider Password'], 3001);
         }
 
         if (isset($options['ApiUrl']) && !empty($options['ApiUrl'])) {
             $this->config['ApiUrl'] = $options['ApiUrl'];
             unset($options['ApiUrl']);
         } else {
-            throw new Registrar_Exception('OpenProvider Registrar module error.<br>Please update configuration parameter "API url" at "Configuration -> Domain registration"');
+            throw new Registrar_Exception('OpenProvider Registrar module error. Please update configuration parameter "API url" at "Configuration -> Domain registration"', [':domain_registrar' => 'OpenProvider', ':missing' => 'OpenProvider API Url'], 3001);
         }
     }
     /**
@@ -93,7 +92,8 @@ public function getTlds(): array
     }
 
     public function registerDomain(Registrar_Domain $domain)
-    { // Step 1: Ensure a customer handle exists
+    {
+        // Step 1: Ensure a customer handle exists
         $customerHandle = $this->_getOrCreateCustomer($domain->getContactAdmin());
 
         // Step 2: Prepare the domain registration data
@@ -106,6 +106,7 @@ public function registerDomain(Registrar_Domain $domain)
             'owner_handle' => $customerHandle,
             'admin_handle' => $customerHandle,
             'tech_handle' => $customerHandle,
+            'billing_handle' => $customerHandle,
             'ns_group' => 'dns-openprovider',
             'autorenew' => 'default'
         ];
@@ -115,7 +116,7 @@ public function registerDomain(Registrar_Domain $domain)
             if ($response['code'] === 0) {
                 return true;
             }
-            throw new Registrar_Exception('Failed to register domain: ' . $response['msg']);
+            return false;
         } catch (Exception $e) {
             throw new Registrar_Exception('OpenProvider API Error: ' . $e->getMessage());
         }
@@ -174,6 +175,7 @@ public function transferDomain(Registrar_Domain $domain)
             'owner_handle' => $customerHandle,
             'admin_handle' => $customerHandle,
             'tech_handle' => $customerHandle,
+            'billing_handle' => $customerHandle,
             'ns_group' => 'dns-openprovider',
             'autorenew' => 'default',
             'auth_code' => $domain->getEpp(),
@@ -240,27 +242,35 @@ public function getDomainDetails(Registrar_Domain $domain)
         $response = $this->_request('GET', "/domains/{$domainId}");
         $opDomain = $response['data'];
 
-        $domain->setRegistrationTime((string) $opDomain['creation_date']);
-        $domain->setExpirationTime((string) $opDomain['expiration_date']);
+        $domain->setRegistrationTime(strtotime($opDomain['creation_date']));
+        $domain->setExpirationTime(strtotime($opDomain['expiration_date']));
         $domain->setPrivacyEnabled($opDomain['is_private_whois_enabled']);
+        $domain->setLocked($opDomain['is_locked']);
 
-        // create new Domain obj to return
-        $newDomain = new Registrar_Domain();
-
-        // set SLD and TLD
-        $newDomain->setSld($domain->getSld());
-        $newDomain->setTld($domain->getTld());
-        $newDomain->setRegistrationTime((string) $opDomain['creation_date']);
-        $newDomain->setExpirationTime((string) $opDomain['expiration_date']);
-        $newDomain->setPrivacyEnabled($opDomain['is_private_whois_enabled']);
+        $nameservers = $opDomain['name_servers'];
+        if (isset($nameservers[0])) {
+            $domain->setNs1($nameservers[0]['name']);
+        }
+        if (isset($nameservers[1])) {
+            $domain->setNs2($nameservers[1]['name']);
+        }
+        if (isset($nameservers[2])) {
+            $domain->setNs3($nameservers[2]['name']);
+        }
+        if (isset($nameservers[3])) {
+            $domain->setNs4($nameservers[3]['name']);
+        }
 
         $registrarContact = new Registrar_Domain_Contact();
         $adminContact = new Registrar_Domain_Contact();
         $techContact = new Registrar_Domain_Contact();
+        $billingContact = new Registrar_Domain_Contact();
+
+        // Get customer info from the api
+        $customer = $this->_getCustomer($opDomain['admin_handle']);
 
         // Set contact data on our Domain obj using info from our API call
-        foreach (['Registrant', 'Admin', 'Tech'] as $contactType) {
-            $owner = $opDomain->owner;
+        foreach (['Registrant', 'Admin', 'Tech', 'Billing'] as $contactType) {
             $contact = $registrarContact;
 
             if ($contactType == 'Admin') {
@@ -269,28 +279,29 @@ public function getDomainDetails(Registrar_Domain $domain)
             if ($contactType == 'Tech') {
                 $contact = $techContact;
             }
+            if ($contactType == 'Billing') {
+                $contact = $billingContact;
+            }
 
-            $split = explode(" ", $owner->full_name);
-            $lastName = end($split);
-            $firstName = str_replace($lastName, '', $owner->full_name);
-
-            $contact->setFirstName((string) $firstName);
-            $contact->setLastName((string) $lastName);
-            // $contact->setEmail((string) $contactApi->EmailAddress);
-            // $contact->setTel((string) $contactApi->Phone);
-            // $contact->setAddress1((string) $contactApi->Address1);
-            // $contact->setAddress2((string) $contactApi->Address2);
-            // $contact->setCity((string) $contactApi->City);
-            // $contact->setState((string) $contactApi->StateProvince);
-            // $contact->setCountry((string) $contactApi->Country);
-            // $contact->setZip((string) $contactApi->PostalCode);
+            $contact->setFirstName($customer['name']['first_name']);
+            $contact->setLastName($customer['name']['last_name']);
+            $contact->setEmail($customer['email']);
+            $contact->setTelCc($customer['phone']['country_code']);
+            $contact->setTel($customer['phone']['subscriber_number']);
+            $contact->setAddress1($customer['address']['street']);
+            $contact->setCity($customer['address']['city']);
+            $contact->setState($customer['address']['state']);
+            $contact->setCountry($customer['address']['country']);
+            $contact->setZip($customer['address']['zipcode']);
+            $contact->setCompany(isset($customer['company_name']) ? $customer['company_name'] : '');
         }
 
-        $newDomain->setContactRegistrar($registrarContact);
-        $newDomain->setContactAdmin($adminContact);
-        $newDomain->setContactTech($techContact);
+        $domain->setContactRegistrar($registrarContact);
+        $domain->setContactAdmin($adminContact);
+        $domain->setContactTech($techContact);
+        $domain->setContactBilling($billingContact);
 
-        return $newDomain;
+        return $domain;
     }
 
     public function modifyNs(Registrar_Domain $domain)
@@ -328,13 +339,14 @@ public function modifyContact(Registrar_Domain $domain)
         $domainId = $this->_getDomainId($domain);
 
         // Step 2: Get or create the customer handle
-        $customerHandle = $this->_getOrCreateCustomer($domain->getContactAdmin());
+        $customerHandle = $this->_getOrCreateCustomer($domain->getContactAdmin(), true);
 
         // Step 3: Prepare the request data
         $data = [
             'owner_handle' => $customerHandle,
             'admin_handle' => $customerHandle,
             'tech_handle' => $customerHandle,
+            'billing_handle' => $customerHandle,
         ];
 
         // Step 4: Send the PUT request to update contact
@@ -434,15 +446,8 @@ private function _getDomainId(Registrar_Domain $domain)
         }
     }
 
-    private function _getOrCreateCustomer(Registrar_Domain_Contact $contact)
+    private function _getOrCreateCustomer(Registrar_Domain_Contact $contact, $updateExisting = false)
     {
-        // Step 1: Check if the customer already exists by email
-        $existingCustomerHandle = $this->_findCustomerByEmail($contact->getEmail());
-        if ($existingCustomerHandle) {
-            return $existingCustomerHandle;
-        }
-
-        // Step 2: Create a new customer if not found
         $data = [
             'email' => $contact->getEmail(),
             'phone' => [
@@ -464,12 +469,25 @@ private function _getOrCreateCustomer(Registrar_Domain_Contact $contact)
             ]
         ];
 
+        // Step 1: Check if the customer already exists by email
+        $existingCustomerHandle = $this->_findCustomerByEmail($contact->getEmail());
+        if ($existingCustomerHandle) {
+            if ($updateExisting) {
+                $response = $this->_request('PUT', "/customers/{$existingCustomerHandle}", $data);
+                if ($response['code'] !== 0) {
+                    throw new Registrar_Exception('Failed to update contact: ' . $response['msg']);
+                }
+            }
+
+            return $existingCustomerHandle;
+        }
+
+        // Step 2: Create a new customer if not found
         try {
             $response = $this->_request('POST', '/customers', $data);
             if (isset($response['data']['handle'])) {
                 return $response['data']['handle'];
             }
-            // var_dump(json_encode($data), $response);
             throw new Registrar_Exception('Failed to create customer: ' . $response['msg']);
         } catch (Exception $e) {
             throw new Registrar_Exception('OpenProvider API Error: ' . $e->getMessage());
@@ -493,6 +511,20 @@ private function _findCustomerByEmail($email)
         }
     }
 
+
+    private function _getCustomer($handle)
+    {
+        try {
+            $response = $this->_request('GET', "/customers/{$handle}");
+            if ($response['code'] === 0 && !empty($response['data'])) {
+                return $response['data']; // Return the customer data
+            }
+            return null; // No matching customer found
+        } catch (Exception $e) {
+            throw new Registrar_Exception('Failed to find customer by email: ' . $e->getMessage());
+        }
+    }
+
     /**
      * Send OpenProvider request
      */
@@ -518,7 +550,7 @@ private function _request($method, $url, $data = []): array
 
     private function _logResponse($method, $url, $data, $response)
     {
-        file_put_contents(self::PATH_LOG . '/' . self::DIR_LOG . '/' . self::FILE_LOG, json_encode([
+        file_put_contents(__DIR__ . '/' . self::DIR_LOG . '/' . self::FILE_LOG, json_encode([
             'method' => $method,
             'url' => $url,
             'data' => $data,
@@ -528,7 +560,7 @@ private function _logResponse($method, $url, $data, $response)
 
     private function _logError($method, $url, $data, $error)
     {
-        file_put_contents(self::PATH_LOG . '/' . self::DIR_LOG . '/' . self::FILE_LOG, json_encode([
+        file_put_contents(__DIR__ . '/' . self::DIR_LOG . '/' . self::FILE_LOG, json_encode([
             'method' => $method,
             'url' => $url,
             'data' => $data,
diff --git a/library/Registrar/Adapter/OpenProvider/API.php b/library/Registrar/Adapter/OpenProvider/API.php
