From 077c27732bee81c784346892ff9d76c1f855f255 Mon Sep 17 00:00:00 2001
From: tbrehm <t.brehm@ispconfig.org>
Date: Wed, 27 Jul 2011 11:18:05 -0400
Subject: [PATCH] Added functions to manage OpenVZ virtual machines to the remote API. Added a example file for adding a VM with the remote API
---
interface/web/admin/form/remote_user.tform.php | 1
interface/lib/classes/remoting.inc.php | 304 ++++++++++++++++++++++++++++++++++++++++++++++++++
remoting_client/examples/openvz_vm_add.php | 42 +++++++
interface/web/vm/templates/openvz.conf.tpl | 3
interface/lib/plugins/vm_openvz_plugin.inc.php | 7
5 files changed, 351 insertions(+), 6 deletions(-)
diff --git a/interface/lib/classes/remoting.inc.php b/interface/lib/classes/remoting.inc.php
index 5e9e45d..53ee957 100644
--- a/interface/lib/classes/remoting.inc.php
+++ b/interface/lib/classes/remoting.inc.php
@@ -1,7 +1,7 @@
<?php
/*
-Copyright (c) 2007 - 2009, Till Brehm, projektfarm Gmbh
+Copyright (c) 2007 - 2011, Till Brehm, projektfarm Gmbh
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
@@ -2257,7 +2257,7 @@
return $affected_rows;
}
- private function deleteQuery($formdef_file, $primary_id)
+ private function deleteQuery($formdef_file, $primary_id, $event_identifier = '')
{
global $app;
@@ -2282,6 +2282,9 @@
$app->db->query($sql);
if($app->db->errorMessage != '') {
+
+ if($event_identifier != '') $app->plugin->raiseEvent($event_identifier,$this);
+
$this->server->fault('database_error', $app->db->errorMessage . ' '.$sql);
return false;
}
@@ -2611,5 +2614,302 @@
return false;
}
}
+
+ //* Functions for virtual machine management
+
+ //* Get OpenVZ OStemplate details
+ public function openvz_ostemplate_get($session_id, $ostemplate_id)
+ {
+ global $app;
+
+ if(!$this->checkPerm($session_id, 'vm_openvz')) {
+ $this->server->fault('permission_denied', 'You do not have the permissions to access this function.');
+ return false;
+ }
+ $app->uses('remoting_lib');
+ $app->remoting_lib->loadFormDef('../vm/form/openvz_ostemplate.tform.php');
+ return $app->remoting_lib->getDataRecord($ostemplate_id);
+ }
+
+ //* Add a openvz ostemplate record
+ public function openvz_ostemplate_add($session_id, $client_id, $params)
+ {
+ if(!$this->checkPerm($session_id, 'vm_openvz')) {
+ $this->server->fault('permission_denied', 'You do not have the permissions to access this function.');
+ return false;
+ }
+ return $this->insertQuery('../vm/form/openvz_ostemplate.tform.php',$client_id,$params);
+ }
+
+ //* Update openvz ostemplate record
+ public function openvz_ostemplate_update($session_id, $client_id, $ostemplate_id, $params)
+ {
+ if(!$this->checkPerm($session_id, 'vm_openvz')) {
+ $this->server->fault('permission_denied', 'You do not have the permissions to access this function.');
+ return false;
+ }
+ $affected_rows = $this->updateQuery('../vm/form/openvz_ostemplate.tform.php',$client_id,$ostemplate_id,$params);
+ return $affected_rows;
+ }
+
+ //* Delete openvz ostemplate record
+ public function openvz_ostemplate_delete($session_id, $ostemplate_id)
+ {
+ if(!$this->checkPerm($session_id, 'vm_openvz')) {
+ $this->server->fault('permission_denied', 'You do not have the permissions to access this function.');
+ return false;
+ }
+ $affected_rows = $this->deleteQuery('../vm/form/openvz_ostemplate.tform.php',$ostemplate_id);
+ return $affected_rows;
+ }
+
+ //* Get OpenVZ template details
+ public function openvz_template_get($session_id, $template_id)
+ {
+ global $app;
+
+ if(!$this->checkPerm($session_id, 'vm_openvz')) {
+ $this->server->fault('permission_denied', 'You do not have the permissions to access this function.');
+ return false;
+ }
+ $app->uses('remoting_lib');
+ $app->remoting_lib->loadFormDef('../vm/form/openvz_template.tform.php');
+ return $app->remoting_lib->getDataRecord($template_id);
+ }
+
+ //* Add a openvz template record
+ public function openvz_template_add($session_id, $client_id, $params)
+ {
+ if(!$this->checkPerm($session_id, 'vm_openvz')) {
+ $this->server->fault('permission_denied', 'You do not have the permissions to access this function.');
+ return false;
+ }
+ return $this->insertQuery('../vm/form/openvz_template.tform.php',$client_id,$params);
+ }
+
+ //* Update openvz template record
+ public function openvz_template_update($session_id, $client_id, $template_id, $params)
+ {
+ if(!$this->checkPerm($session_id, 'vm_openvz')) {
+ $this->server->fault('permission_denied', 'You do not have the permissions to access this function.');
+ return false;
+ }
+ $affected_rows = $this->updateQuery('../vm/form/openvz_template.tform.php',$client_id,$template_id,$params);
+ return $affected_rows;
+ }
+
+ //* Delete openvz template record
+ public function openvz_template_delete($session_id, $template_id)
+ {
+ if(!$this->checkPerm($session_id, 'vm_openvz')) {
+ $this->server->fault('permission_denied', 'You do not have the permissions to access this function.');
+ return false;
+ }
+ $affected_rows = $this->deleteQuery('../vm/form/openvz_template.tform.php',$template_id);
+ return $affected_rows;
+ }
+
+ //* Get OpenVZ ip details
+ public function openvz_ip_get($session_id, $ip_id)
+ {
+ global $app;
+
+ if(!$this->checkPerm($session_id, 'vm_openvz')) {
+ $this->server->fault('permission_denied', 'You do not have the permissions to access this function.');
+ return false;
+ }
+ $app->uses('remoting_lib');
+ $app->remoting_lib->loadFormDef('../vm/form/openvz_ip.tform.php');
+ return $app->remoting_lib->getDataRecord($ip_id);
+ }
+
+ //* Get OpenVZ a free IP address
+ public function openvz_get_free_ip($session_id, $server_id = 0)
+ {
+ global $app;
+
+ if(!$this->checkPerm($session_id, 'vm_openvz')) {
+ $this->server->fault('permission_denied', 'You do not have the permissions to access this function.');
+ return false;
+ }
+ $server_id = intval($server_id);
+
+ if($server_id > 0) {
+ $tmp = $app->db->queryOneRecord("SELECT ip_address_id, server_id, ip_address FROM openvz_ip WHERE reserved = 'n' AND vm_id = 0 AND server_id = $server_id LIMIT 0,1");
+ } else {
+ $tmp = $app->db->queryOneRecord("SELECT ip_address_id, server_id, ip_address FROM openvz_ip WHERE reserved = 'n' AND vm_id = 0 LIMIT 0,1");
+ }
+
+ if(count($tmp) > 0) {
+ return $tmp;
+ } else {
+ $this->server->fault('no_free_ip', 'There is no free IP available.');
+ }
+ }
+
+ //* Add a openvz ip record
+ public function openvz_ip_add($session_id, $client_id, $params)
+ {
+ if(!$this->checkPerm($session_id, 'vm_openvz')) {
+ $this->server->fault('permission_denied', 'You do not have the permissions to access this function.');
+ return false;
+ }
+ return $this->insertQuery('../vm/form/openvz_ip.tform.php',$client_id,$params);
+ }
+
+ //* Update openvz ip record
+ public function openvz_ip_update($session_id, $client_id, $ip_id, $params)
+ {
+ if(!$this->checkPerm($session_id, 'vm_openvz')) {
+ $this->server->fault('permission_denied', 'You do not have the permissions to access this function.');
+ return false;
+ }
+ $affected_rows = $this->updateQuery('../vm/form/openvz_ip.tform.php',$client_id,$ip_id,$params);
+ return $affected_rows;
+ }
+
+ //* Delete openvz ip record
+ public function openvz_ip_delete($session_id, $ip_id)
+ {
+ if(!$this->checkPerm($session_id, 'vm_openvz')) {
+ $this->server->fault('permission_denied', 'You do not have the permissions to access this function.');
+ return false;
+ }
+ $affected_rows = $this->deleteQuery('../vm/form/openvz_ip.tform.php',$ip_id);
+ return $affected_rows;
+ }
+
+ //* Get OpenVZ vm details
+ public function openvz_vm_get($session_id, $vm_id)
+ {
+ global $app;
+
+ if(!$this->checkPerm($session_id, 'vm_openvz')) {
+ $this->server->fault('permission_denied', 'You do not have the permissions to access this function.');
+ return false;
+ }
+ $app->uses('remoting_lib');
+ $app->remoting_lib->loadFormDef('../vm/form/openvz_vm.tform.php');
+ return $app->remoting_lib->getDataRecord($vm_id);
+ }
+
+ //* Add a openvz vm record
+ public function openvz_vm_add($session_id, $client_id, $params)
+ {
+ if(!$this->checkPerm($session_id, 'vm_openvz')) {
+ $this->server->fault('permission_denied', 'You do not have the permissions to access this function.');
+ return false;
+ }
+ return $this->insertQuery('../vm/form/openvz_vm.tform.php',$client_id,$params);
+ }
+
+ //* Add a openvz vm record from template
+ public function openvz_vm_add_from_template($session_id, $client_id, $ostemplate_id, $template_id, $override_params = array())
+ {
+ global $app;
+
+ if(!$this->checkPerm($session_id, 'vm_openvz')) {
+ $this->server->fault('permission_denied', 'You do not have the permissions to access this function.');
+ return false;
+ }
+
+
+ $template_id = intval($template_id);
+ $ostemplate_id = intval($ostemplate_id);
+
+ //* Verify parameters
+ if($template_id == 0) {
+ $this->server->fault('template_id_error', 'Template ID must be > 0.');
+ return false;
+ }
+ if($ostemplate_id == 0) {
+ $this->server->fault('ostemplate_id_error', 'OSTemplate ID must be > 0.');
+ return false;
+ }
+
+ // Verify if template and ostemplate exist
+ $tmp = $app->db->queryOneRecord("SELECT template_id FROM openvz_template WHERE template_id = $template_id");
+ if(!is_array($tmp)) {
+ $this->server->fault('template_id_error', 'Template does not exist.');
+ return false;
+ }
+ $tmp = $app->db->queryOneRecord("SELECT ostemplate_id FROM openvz_ostemplate WHERE ostemplate_id = $ostemplate_id");
+ if(!is_array($tmp)) {
+ $this->server->fault('ostemplate_id_error', 'OSTemplate does not exist.');
+ return false;
+ }
+
+ //* Get the template
+ $vtpl = $app->db->queryOneRecord("SELECT * FROM openvz_template WHERE template_id = $template_id");
+
+ //* Get the IP address and server_id
+ if($override_params['server_id'] > 0) {
+ $vmip = $app->db->queryOneRecord("SELECT ip_address_id, server_id, ip_address FROM openvz_ip WHERE reserved = 'n' AND vm_id = 0 AND server_id = ".$override_params['server_id']." LIMIT 0,1");
+ } else {
+ $vmip = $app->db->queryOneRecord("SELECT ip_address_id, server_id, ip_address FROM openvz_ip WHERE reserved = 'n' AND vm_id = 0 LIMIT 0,1");
+ }
+ if(!is_array($vmip)) {
+ $this->server->fault('vm_ip_error', 'Unable to get a free VM IP.');
+ return false;
+ }
+
+ //* Build the $params array
+ $params = array();
+ $params['server_id'] = $vmip['server_id'];
+ $params['ostemplate_id'] = $ostemplate_id;
+ $params['template_id'] = $template_id;
+ $params['ip_address'] = $vmip['ip_address'];
+ $params['hostname'] = (isset($override_params['hostname']))?$override_params['hostname']:$vtpl['hostname'];
+ $params['vm_password'] = (isset($override_params['vm_password']))?$override_params['vm_password']:$app->auth->get_random_password(10);
+ $params['start_boot'] = (isset($override_params['start_boot']))?$override_params['start_boot']:'y';
+ $params['active'] = (isset($override_params['active']))?$override_params['active']:'y';
+ $params['active_until_date'] = (isset($override_params['active_until_date']))?$override_params['active_until_date']:'0000-00-00';
+ $params['description'] = (isset($override_params['description']))?$override_params['description']:'';
+
+ //* The next params get filled with pseudo values, as the get replaced
+ //* by the openvz event plugin anyway with values from the template
+ $params['veid'] = 1;
+ $params['diskspace'] = 1;
+ $params['ram'] = 1;
+ $params['ram_burst'] = 1;
+ $params['cpu_units'] = 1;
+ $params['cpu_num'] = 1;
+ $params['cpu_limit'] = 1;
+ $params['io_priority'] = 1;
+ $params['nameserver'] = '8.8.8.8 8.8.4.4';
+ $params['create_dns'] = 'n';
+ $params['capability'] = '';
+
+ return $this->insertQuery('../vm/form/openvz_vm.tform.php',$client_id,$params,'vm:openvz_vm:on_after_insert');
+ }
+
+ //* Update openvz vm record
+ public function openvz_vm_update($session_id, $client_id, $vm_id, $params)
+ {
+ if(!$this->checkPerm($session_id, 'vm_openvz')) {
+ $this->server->fault('permission_denied', 'You do not have the permissions to access this function.');
+ return false;
+ }
+ $affected_rows = $this->updateQuery('../vm/form/openvz_vm.tform.php',$client_id,$vm_id,$params,'vm:openvz_vm:on_after_update');
+ return $affected_rows;
+ }
+
+ //* Delete openvz vm record
+ public function openvz_vm_delete($session_id, $vm_id)
+ {
+ if(!$this->checkPerm($session_id, 'vm_openvz')) {
+ $this->server->fault('permission_denied', 'You do not have the permissions to access this function.');
+ return false;
+ }
+ $affected_rows = $this->deleteQuery('../vm/form/openvz_vm.tform.php',$vm_id,'vm:openvz_vm:on_after_delete');
+ return $affected_rows;
+ }
+
+
+
+
+
+
+
}
?>
\ No newline at end of file
diff --git a/interface/lib/plugins/vm_openvz_plugin.inc.php b/interface/lib/plugins/vm_openvz_plugin.inc.php
index a926c0a..b1ce8e6 100644
--- a/interface/lib/plugins/vm_openvz_plugin.inc.php
+++ b/interface/lib/plugins/vm_openvz_plugin.inc.php
@@ -140,13 +140,14 @@
private function makeOpenVZConfig() {
global $app, $conf;
- $vm = $app->tform->getDataRecord($this->id);
+ $vm = $app->db->queryOneRecord("SELECT * FROM openvz_vm WHERE vm_id = ".$this->id);
$vm_template = $app->db->queryOneRecord("SELECT * FROM openvz_template WHERE template_id = ".$vm['template_id']);
$burst_ram = $vm['ram_burst']*256;
$guar_ram = $vm['ram']*256;
+ $app->load('tpl');
$tpl = new tpl();
- $tpl->newTemplate('templates/openvz.conf.tpl');
+ $tpl->newTemplate('../vm/templates/openvz.conf.tpl');
$onboot = ($vm['start_boot'] == 'y')?'yes':'no';
$tpl->setVar('onboot',$onboot);
@@ -205,7 +206,7 @@
private function createDNS() {
global $app, $conf;
- $vm = $app->tform->getDataRecord($this->id);
+ $vm = $app->db->queryOneRecord("SELECT * FROM openvz_vm WHERE vm_id = ".$this->id);
if($vm['create_dns'] != 'y') return;
diff --git a/interface/web/admin/form/remote_user.tform.php b/interface/web/admin/form/remote_user.tform.php
index 1a3824a..f8d1dc7 100644
--- a/interface/web/admin/form/remote_user.tform.php
+++ b/interface/web/admin/form/remote_user.tform.php
@@ -72,6 +72,7 @@
$function_list['dns_srv_get,dns_srv_add,dns_srv_update,dns_srv_delete'] = 'DNS srv functions';
$function_list['dns_txt_get,dns_txt_add,dns_txt_update,dns_txt_delete'] = 'DNS txt functions';
$function_list['domains_domain_get,domains_domain_add,domains_domain_delete,domains_get_all_by_user'] = 'Domaintool functions';
+$function_list['vm_openvz'] = 'OpenVZ VM functions';
$form["title"] = "Remote user";
$form["description"] = "";
diff --git a/interface/web/vm/templates/openvz.conf.tpl b/interface/web/vm/templates/openvz.conf.tpl
index c4c82c0..06e6ac5 100644
--- a/interface/web/vm/templates/openvz.conf.tpl
+++ b/interface/web/vm/templates/openvz.conf.tpl
@@ -43,6 +43,7 @@
HOSTNAME="{tmpl_var name='hostname'}"
IP_ADDRESS="{tmpl_var name='ip_address'}"
NAMESERVER="{tmpl_var name='nameserver'}"
-MEMINFO="pages:256000"
+# alternative meminfo: "pages:256000"
+MEMINFO="privvmpages:1"
CAPABILITY="{tmpl_var name='capability'}"
diff --git a/remoting_client/examples/openvz_vm_add.php b/remoting_client/examples/openvz_vm_add.php
new file mode 100644
index 0000000..d8e46c6
--- /dev/null
+++ b/remoting_client/examples/openvz_vm_add.php
@@ -0,0 +1,42 @@
+<?php
+
+$username = 'admin';
+$password = 'admin';
+
+$soap_location = 'http://localhost:8080/remote/index.php';
+$soap_uri = 'http://localhost:8080/remote/';
+
+
+$client = new SoapClient(null, array('location' => $soap_location,
+ 'uri' => $soap_uri,
+ 'trace' => 1,
+ 'exceptions' => 1));
+
+
+try {
+ if($session_id = $client->login($username,$password)) {
+ echo 'Logged successfull. Session ID:'.$session_id.'<br />';
+ }
+
+ //* Prams are optional for this function. If params are set,
+ //* then they override the template settings.
+ $params = array();
+
+ //* Set the function parameters.
+ $client_id = 0;
+ $ostemplate_id = 1;
+ $template_id = 1;
+
+ $vm_id = $client->openvz_vm_add_from_template($session_id, $client_id, $ostemplate_id, $template_id, $params);
+
+ if($client->logout($session_id)) {
+ echo 'Logged out.<br />';
+ }
+
+
+} catch (SoapFault $e) {
+ echo $client->__getLastResponse();
+ die('SOAP Error: '.$e->getMessage());
+}
+
+?>
--
Gitblit v1.9.1