Merge pull request #24 from UpCloudLtd/feat/configurable-api-base-url

feat: make API base URL configurable

Author: scop

apis/upcloudvps_api.php

@@ -35,13 +35,14 @@ class UpcloudvpsApi
      * Constructor.
      *
      * @param array $params API connection parameters including:
+     *  - baseUrl (string) The API base URL
      *  - apiToken (string) The API token
      *  - moduleVer (string) The current module version
      *  - blestaVer (string) The current Blesta version
      */
     public function __construct(array $params)
     {
-        $this->baseurl = "https://api.upcloud.com/1.3/";
+        $this->baseurl = $params['baseUrl'];
         $this->blestaVer = $params['blestaVer'];
         $this->setHttpHeader('Authorization', 'Bearer ' . $params['apiToken']);
         $this->moduleVer = $params['moduleVer'] ?? 'dev';

language/en_us/upcloud.php

@@ -22,6 +22,7 @@
 $lang['Upcloudvps.edit_row.edit_btn'] = 'Edit Server';
 $lang['Upcloudvps.row_meta.account_name'] = 'Account Name';
 $lang['Upcloudvps.row_meta.api_token'] = 'API Token';
+$lang['Upcloudvps.row_meta.api_base_url'] = 'API Base URL (optional)';
 $lang['Upcloudvps.module_row'] = 'Account';
 $lang['Upcloudvps.module_row_plural'] = 'Accounts';
 $lang['Upcloudvps.description'] = 'The UpCloud module make UpCloud VPS management simple and intuitive. Common tasks such as a ordering VPS, Start, Stop, Reboot, Change Password, View Data Usage are only a few clicks away.';

upcloud.php

@@ -45,11 +45,6 @@ public function manageAddRow(array &$vars)
         $this->view->base_uri = $this->base_uri;
         $this->view->setDefaultView('components' . DS . 'modules' . DS . 'upcloud' . DS);
         Loader::loadHelpers($this, ['Form', 'Html', 'Widget']);
-        if (!empty($vars)) {
-            if (empty($vars['use_ssl'])) {
-                $vars['use_ssl'] = 'false';
-            }
-        }
         $this->view->set('vars', (object) $vars);
         return $this->view->fetch();
     }
@@ -69,10 +64,6 @@ public function manageEditRow($module_row, array &$vars)
         Loader::loadHelpers($this, ['Form', 'Html', 'Widget']);
         if (empty($vars)) {
             $vars = $module_row->meta;
-        } else {
-            if (empty($vars['use_ssl'])) {
-                $vars['use_ssl'] = 'false';
-            }
         }
         $this->view->set('vars', (object) $vars);
         return $this->view->fetch();
@@ -88,7 +79,7 @@ public function manageEditRow($module_row, array &$vars)
      */
     public function addModuleRow(array &$vars)
     {
-        $meta_fields = ['account_name', 'api_token'];
+        $meta_fields = ['account_name', 'api_token', 'api_base_url'];
         $encrypted_fields = ['api_token'];
         $this->Input->setRules($this->getRowRules($vars));
         if ($this->Input->validates($vars)) {
@@ -117,11 +108,8 @@ public function addModuleRow(array &$vars)
      */
     public function editModuleRow($module_row, array &$vars)
     {
-        $meta_fields = ['account_name', 'api_token'];
+        $meta_fields = ['account_name', 'api_token', 'api_base_url'];
         $encrypted_fields = ['api_token'];
-        if (empty($vars['use_ssl'])) {
-            $vars['use_ssl'] = 'false';
-        }
         $this->Input->setRules($this->getRowRules($vars));
         if ($this->Input->validates($vars)) {
             $meta = [];
@@ -165,7 +153,7 @@ private function getRowRules(&$vars)
                 'valid_connection' => [
                     'rule' => [
                         [$this, 'validateConnection'],
-                        $vars['api_token'],
+                        $vars['api_base_url'],
                     ],
                     'message' => Language::_('Upcloudvps.!error.api_token_valid_connection', true)
                 ]
@@ -179,12 +167,13 @@ private function getRowRules(&$vars)
      * Validates the connection to the UpCloud API using provided credentials.
      *
      * @param string $api_token The UpCloud API token
+     * @param string $api_base_url The UpCloud API base URL
      * @return bool True if the connection is successful, false otherwise
      */
-    public function validateConnection($api_token)
+    public function validateConnection($api_token, $api_base_url)
     {
         try {
-            $api = $this->getApi($api_token);
+            $api = $this->getApi($api_token, $api_base_url);
             $result = $api->GetAccountInfo();
             $this->log('upcloud|accountRequest', serialize($result), 'input', true);
             if ($result['response_code'] == '200') {
@@ -199,9 +188,10 @@ public function validateConnection($api_token)
      * Initializes and returns an instance of the UpcloudvpsApi.
      *
      * @param string $api_token The UpCloud API token
+     * @param string $api_base_url The UpCloud API base URL (optional)
      * @return UpcloudvpsApi An instance of the UpCloud API wrapper
      */
-    private function getApi($api_token)
+    private function getApi($api_token, $api_base_url = null)
     {
         Loader::load(dirname(__FILE__) . DS . 'apis' . DS . 'upcloudvps_api.php');
         Loader::loadComponents($this, ['Record']);
@@ -217,6 +207,7 @@ private function getApi($api_token)
         }
         $blestaVer = $setting->value;
         $params = [
+            'baseUrl' => empty($api_base_url) ? 'https://api.upcloud.com/1.3/' : $api_base_url,
             'apiToken' => $api_token,
             'blestaVer' => $blestaVer,
             'moduleVer' => $this->config->version,
@@ -233,7 +224,7 @@ private function getApi($api_token)
      */
     private function getServerPlans($module_row)
     {
-        $api = $this->getApi($module_row->meta->api_token);
+        $api = $this->getApi($module_row->meta->api_token, $module_row->meta->api_base_url);
         $result = $api->Getplans()['response']['plans']['plan'];
         //$this->log('upcloud|Getplans', serialize($result), 'input', true);
         $Vmplans = [];
@@ -255,7 +246,7 @@ private function getServerPlans($module_row)
      */
     private function getTemplates($module_row, $package = null)
     {
-        $api = $this->getApi($module_row->meta->api_token);
+        $api = $this->getApi($module_row->meta->api_token, $module_row->meta->api_base_url);
         $result_os = $api->GetTemplate()['response']['storages']['storage'];
         //$this->log('upcloud|GetTemplates', serialize($result_os), 'input', true);
         $templates = [];
@@ -283,7 +274,7 @@ private function getTemplates($module_row, $package = null)
      */
     private function getLocations($module_row)
     {
-        $api = $this->getApi($module_row->meta->api_token);
+        $api = $this->getApi($module_row->meta->api_token, $module_row->meta->api_base_url);
         $zones = $api->GetZones()['response']['zones']['zone'];
         // $this->log('upcloud|getLocations', serialize($zones), 'input', true);
         $zoneLocation = [];
@@ -556,7 +547,7 @@ private function performServiceAction($service, $actionName, $logTag, $expectedR
     {
         $module_row = $this->getModuleRow();
         if ($module_row) {
-            $api = $this->getApi($module_row->meta->api_token);
+            $api = $this->getApi($module_row->meta->api_token, $module_row->meta->api_base_url);
             $service_fields = $this->serviceFieldsToObject($service->fields);
             $vmId = $service_fields->upcloudvps_vmid;
             //$this->log($logTag, serialize(['vm_id' => $vmId]), 'input', true);
@@ -749,7 +740,7 @@ public function addService($package, array $vars = null, $parent_package = null,
             $this->log('upcloud|create', serialize($params), 'input', true);
 
             try {
-                $api = $this->getApi($row->meta->api_token);
+                $api = $this->getApi($row->meta->api_token, $row->meta->api_base_url);
                 if (empty($vars['upcloudvps_vmid'])) {
                     $server = $api->CreateServer($params);
                     $this->log('upcloud', serialize($server), 'output', true);
@@ -869,7 +860,7 @@ public function editService($package, $service, array $vars = null, $parent_pack
             }
         }
         if ($vars['use_module'] == 'true' && !isset($delta['upcloudvps_vmid'])) {
-            $api = $this->getApi($row->meta->api_token);
+            $api = $this->getApi($row->meta->api_token, $row->meta->api_base_url);
             if ($this->Input->errors()) {
                 return;
             }
@@ -1071,7 +1062,7 @@ private function getServiceInfo($service, $package, $client = false)
     {
         $row = $this->getModuleRow();
         $service_fields = $this->serviceFieldsToObject($service->fields);
-        $api = $this->getApi($row->meta->api_token);
+        $api = $this->getApi($row->meta->api_token, $row->meta->api_base_url);
         $response = $api->GetServer($service_fields->upcloudvps_vmid)['response']['server'];
         $server_details = $response ?? (object) [];
         $this->view = new View($client ? 'client_service_info' : 'admin_service_info', 'default');
@@ -1216,7 +1207,7 @@ private function getTabActions($package, $service, array $post = null, $client =
         Loader::loadModels($this, ['Services']);
         $service_fields = $this->serviceFieldsToObject($service->fields);
         $templates = $this->getTemplates($row, $package);
-        $api = $this->getApi($row->meta->api_token);
+        $api = $this->getApi($row->meta->api_token, $row->meta->api_base_url);
         //  $this->log('upcloud|GetVMInformation', serialize($service_fields), 'input', true);
         $vmId = $service_fields->upcloudvps_vmid;
         $server_details = $api->GetServer($vmId)['response']['server'];
@@ -1379,7 +1370,7 @@ private function generatePassword()
     public function changeServicePackage($package_from, $package_to, $service, $parent_package = null, $parent_service = null)
     {
         if (($row = $this->getModuleRow())) {
-            $api = $this->getApi($row->meta->api_token);
+            $api = $this->getApi($row->meta->api_token, $row->meta->api_base_url);
             if ($package_from->meta->server_plan != $package_to->meta->server_plan) {
                 $service_fields = $this->serviceFieldsToObject($service->fields);
                 $action = $api->ModifyServer($service_fields->upcloudvps_vmid, $package_to->meta->server_plan);

views/default/add_row.pdt

@@ -23,6 +23,12 @@ $this->Widget->create($this->_('Upcloudvps.add_row.box_title', true));
                 $this->Form->fieldText('api_token', (isset($vars->api_token) ? $vars->api_token : null));
                 ?>
             </li>
+            <li>
+                <?php
+                $this->Form->label($this->_('Upcloudvps.row_meta.api_base_url', true), 'api_base_url');
+                $this->Form->fieldText('api_base_url', (isset($vars->api_base_url) ? $vars->api_base_url : null));
+                ?>
+            </li>
         </ul>
     </div>
 

views/default/edit_row.pdt

@@ -23,6 +23,12 @@ $this->Widget->create($this->_('Upcloudvps.edit_row.box_title', true));
                 $this->Form->fieldText('api_token', (isset($vars->api_token) ? $vars->api_token : null));
                 ?>
             </li>
+            <li>
+                <?php
+                $this->Form->label($this->_('Upcloudvps.row_meta.api_base_url', true), 'api_base_url');
+                $this->Form->fieldText('api_base_url', (isset($vars->api_base_url) ? $vars->api_base_url : null));
+                ?>
+            </li>
         </ul>
     </div>