![[tokkee]](http://tokkee.org/images/avatar.png){kind=avatar}
diff --git a/plugins/gofon/macro/class_gofonMacroParameters.inc b/plugins/gofon/macro/class_gofonMacroParameters.inc
index 5f0beab9d1cebee4686abdb18797438abc55c5ba..19085a904b758a40a356499e508cff574633ff9d 100755 (executable)
<?php
+//! This class handles the goFonMacroParameter
+/*! In this class all parameters from goFonMacroContent \n
+ and all (if given) already defined parameters are managed \n
+ \n
+ Parameters will be saved to openldap like this :\n
+ goFonMacroParameter: ID!NAME:!TYPE(string:combo:bool)!DEFAULT_VALUE\n
+ In Case of type=combo the DEFAULT_VALUE specifies the entries in the listbox, like this\n
+ "first:second:third:last" \n
+*/
class macroParameter extends plugin
{
- /* CLI vars */
+ /*! CLI vars */
var $cli_summary= "Handling of GOsa's application object";
+ /*! CLI vars */
var $cli_description= "Some longer text\nfor help";
+ /*! CLI vars */
var $cli_parameters= array("eins" => "Eins ist toll", "zwei" => "Zwei ist noch besser");
- /* application attributes */
+ /* Parameter Count*/
+ var $para_count = 0 ;
+ /*! macro base */
var $base= "";
+
+ /*! This array contains all Parameter defined for the macro*/
var $goFonMacroParameter =array();
- /* attribute list for save action */
+ /*! This are the available types for a macro */
+ var $type_shortcut= array("string" => array("selected", "", ""),
+ "combo" => array("", "selected", ""),
+ "bool" => array("", "", "selected"));
+
+ /*! attribute list for save action */
var $attributes= array("base","goFonMacroParameter");
+
+ /*! Objectclasses needed by the class*/
var $objectclasses= array("top", "goFonMacro");
+ //! The konstructor of macroParameter
+ /*! The konstructor of macroParameter...
+ - reads goFonMacroParameter and parses them to an array
+ - Set attributes from openldap (edit)
+ - Set attributes from default (new)
+ */
function macroParameter ($config, $dn= NULL)
{
plugin::plugin ($config, $dn);
}
/* initialising macro parameter */
- unset($this->attrs['goFonMacroParameter']['count']);
+ if(isset($this->attrs['goFonMacroParameter']) &&
+ isset($this->attrs['goFonMacroParameter']['count'])){
+ unset($this->attrs['goFonMacroParameter']['count']);
+ }
/* Set Parameters, or a new array if ther are no parameters */
if(isset($this->attrs['goFonMacroParameter'])){
$this->goFonMacroParameter[] = $tmp3;
}
}
-
- foreach($this->goFonMacroParameter as $para){
+ /* Load parametersettings*/
+ foreach($this->goFonMacroParameter as $para){
$tmp = split("!",$para);
- $num = preg_replace("/[^0-9]/","",$tmp[1]);
- $tmp2[$num]['name'] = $tmp[1];
+ $num = $tmp[0];
+ $tmp2[$num]['name'] = base64_decode($tmp[1]);
$tmp2[$num]['type'] = $tmp[2];
$tmp2[$num]['default'] = $tmp[3];
+ $tmp2[$num]['var'] = "var".$num;
}
-
+
+
/* Assign this array */
$this->goFonMacroParameter = $tmp2;
- }
-function check_paras($content,$goFonMacroParameter)
- {
- preg_match_all("/[$]\{ARG[0-9]*\}/",$content,$res,PREG_OFFSET_CAPTURE);
-
- $anz = count($res[0]);
- $new = array();
+ $this->para_count = count ($tmp2);
+
+ }
- foreach($res[0] as $val){
- $num = preg_replace("/[^0-9]/","",$val[0]);
- $new[$num]['val'] = $val[0];
- $new[$num]['num'] = $num;
+ //! Perform Parameter check
+ /*!
+ Compares the given parameters (goFonMacroParameters) with the parameters defined in goFonContent\n
+ -> Decide which attrs are new and which are unused\n
+ -> Sort result array (containing both parameters 'goFonMacroParameters/goFonContent' and new / unused info)\n
+ \param $content The given goFonContent for this macro\n
+ \param $goFonMacroParameter Array with the already given parameters \n
+ */
+ function check_paras($content,$goFonMacroParameter)
+ {
+ /* Check contents for parameters */
+ preg_match_all("/[$]\{ARG[0-9]*\}/",$content,$res,PREG_OFFSET_CAPTURE);
+
+ $new = array();
+
+ /* Detect parameters with positions */
+ foreach($res[0] as $val){
+ $num = preg_replace("/[^0-9]/","",$val[0]);
+ $new[$num]['val'] = $val[0];
+ $new[$num]['num'] = $num;
}
-
- foreach($goFonMacroParameter as $gokey => $goval){
- foreach($new as $nkey => $nval){
- if($gokey == $nval['num']){
- $goFonMacroParameter[$gokey]['check']= true;
+
+ /* Compare content parameter and macro parameter */
+ foreach($goFonMacroParameter as $gokey => $goval){
+ foreach($new as $nkey => $nval){
+ if($gokey == $nval['num']){
+ /* sign this as OK */
+ $goFonMacroParameter[$gokey]['check']= true;
}
}
}
- foreach($new as $key => $val){
- $goFonMacroParameter[$key]['check']= true;
- if((!isset($goFonMacroParameter[$key]['name']))||(empty($goFonMacroParameter[$key]['name']))){
- $goFonMacroParameter[$key]['name']="\${ARG".$key."}";
- }
- }
- foreach($goFonMacroParameter as $key => $val){
- if(!isset($goFonMacroParameter[$key]['check'])){
- $goFonMacroParameter[$key]['check']= false;
+ /* Now check if there is new parameter in the content, which is not assigned yet */
+ foreach($new as $key => $val){
+ /* Assign std values */
+ $goFonMacroParameter[$key]['var']="var".$key;
+ $goFonMacroParameter[$key]['check']= true;
+
+ /* If this is a new Parameter, name it ${ARG#} by default*/
+ if((!isset($goFonMacroParameter[$key]['name']))||(empty($goFonMacroParameter[$key]['name']))){
+ $goFonMacroParameter[$key]['name']="\${ARG".$key."}";
+ }
+ }
+
+ foreach($goFonMacroParameter as $key => $val){
+ /* All attributes with check == false, are unneeded so mark them with ['check']= false */
+ if(!isset($goFonMacroParameter[$key]['check'])){
+ $goFonMacroParameter[$key]['check']= false;
}
- if(!isset($goFonMacroParameter[$key]['default'])){
- $goFonMacroParameter[$key]['default'] = "";
+ /* Ah no default given assign ="" to prevent unsigned index */
+ if(!isset($goFonMacroParameter[$key]['default'])){
+ $goFonMacroParameter[$key]['default'] = "";
}
}
- asort($goFonMacroParameter);
- return($goFonMacroParameter);
-
- }
-
-
-
-
-
+ /* Sort output for better reading */
+ asort($goFonMacroParameter);
+ return($goFonMacroParameter);
+ }
+ //! Execute this Plugin
+ /*!
+ Perform Parameter check \n
+ Draw paramter table\n
+ Show tpl \n
+ */
function execute()
{
+ /* Call parent execute */
+ plugin::execute();
/* Variables */
$vars = "";
$tmp = array();
$number = 0;
-
+
$content = $_SESSION['macroManagment']->macrotabs->by_object['macro']->goFonMacroContent;
if(strstr($content,"ARG")){
- $vorpos = strpos($content,"ARG");
- $rest = substr($content,$vorpos, strlen($content));
+ $vorpos = strpos($content,"ARG");
+ $rest = substr($content,$vorpos, strlen($content));
}
/* Do we represent a valid group? */
if (!$this->is_account && $this->parent == NULL){
$display= "<img alt=\"\" src=\"images/stop.png\" align=\"middle\"> <b>".
- _("This 'dn' is no application.")."</b>";
+ _("This 'dn' is no phone macro.")."</b>";
return ($display);
}
}
$number= count($this->goFonMacroParameter);
$number++;
- $this->goFonMacroParameter[]=array("name"=>"new","type"=>"string","default"=>"test");
+ $this->goFonMacroParameter[]=array("var"=>"var","name"=>"new","type"=>"string","default"=>"test");
}
- /* read out post data, and assign it to the parameters */
- /* And or delete */
- foreach($_POST as $name=>$value){
-
- /* Test if there is a variable begining with "del" */
- if(preg_match("/del/",$name)){
-
- /* Extract entry id to delete */
- $nr = str_replace("del","",$name) ;
-
- /* unset entry */
- unset($this->goFonMacroParameter[$nr]);
+ /*generate Table which shows als parameters */
+ $FonParas = $this->check_paras($content,$this->goFonMacroParameter);
- }elseif(preg_match("/number/",$name)){
- /* Set Post vars */
- $key = $_POST[$name];
- $this->goFonMacroParameter[$key]['name'] =$_POST["varname".$key];
- $this->goFonMacroParameter[$key]['type'] =$_POST["vartype".$key];
- $this->goFonMacroParameter[$key]['default'] =$_POST["default".$key];
- }
- }
+ /* Sort by Parameterid, and keep keys */
+ ksort($FonParas);
- /*generate Table which shows als parameters */
-
- $FonParas = $this->check_paras($content,$this->goFonMacroParameter);
-
foreach($FonParas as $key=>$para) {
- if(isset($para['type'])){
- if($para['type']=="string") {
- $sel1 = "selected";
- $sel2 = "";
- $sel3 = "";
- }elseif($para['type']=="combo"){
- $sel1 = "";
- $sel2 = "selected";
- $sel3 = "" ;
+ /* Select correct item of combobox */
+ if(isset($para['type'])){
+ list($sel1, $sel2, $sel3)= $this->type_shortcut[$para['type']];
}else{
- $sel1 = "";
- $sel3 = "selected";
- $sel2 = "" ;
+ list($sel1, $sel2, $sel3)= array("", "", "");
}
- }else{
- $sel1 = "";
- $sel3 = "";
- $sel2 = "" ;
- }
+ /* Assemble output table */
$vars .="<tr>
- <td><input name=\"number".$key."\" value='".$key."' type='hidden'> </td>
- <td><input name='varname".$key."' type='hidden' value='".$para['name']."'>".$para['name']."</td>
<td>
- <select name='vartype".$key."'>
- <option name='vartype".$key."' value='string' ".$sel1.">string</option>
- <option name='vartype".$key."' value='combo' ".$sel2.">combo</option>
- <option name='vartype".$key."' value='bool' ".$sel3.">bool</option>
- </select>
+ <input name=\"number".$key."\" value='".$key."' type='hidden'>
+ <input name='var".$key."' type='hidden' value='".$para['var']."'>ARG".$key."
</td>
- <td><input name='default".$key."' value='".$para['default']."'></td>
- <td>";
- if($para['check']==true) {
- $vars.=_("Ok");
- $vars.=" <td></td>";
- }else{
- $vars.=_("Unused");
- $vars.=" <td><input name='del".$key."' value='delete' type='submit'></td>";
+ <td><input size=\"45\" name='varname".$key."' value='".$para['name']."'></td>
+ <td>
+ <select name='vartype".$key."'>
+ <option value='string' ".$sel1.">"._("String")." </option>
+ <option value='combo' ".$sel2.">"._("Combobox")." </option>
+ <option value='bool' ".$sel3.">"._("Bool")." </option>
+ </select>
+ </td>
+ <td><input size=\"45\" name='default".$key."' value='".$para['default']."'></td>
+ <td> ";
+ if($para['check']==false) {
+ $vars.="<input name='del".$key."' value='"._("Delete unused")."' type='submit'>";
}
-
- $vars.=" </tr>";
-
+ $vars.=" </td></tr>";
}
/* Checkboxes */
$smarty->assign("base_select", $this->base);
$smarty->assign("vars", $vars);
-
/* Show main page */
return($smarty->fetch (get_template_path('parameter.tpl', TRUE)));
}
-
+
+ //! Unused here
+ /*!
+ Unused here because goFonMacro will remove this Macro\n
+ */
function remove_from_parent()
{
- /*
- $ldap= $this->config->get_ldap_link();
- $ldap->rmDir($this->dn);
-
- /* Optionally execute a command after we're done * /
- $this->handle_post_events("remove");
-
- /* Delete references to object groups * /
- $ldap->cd ($this->config->current['BASE']);
- $ldap->search ("(&(objectClass=gosaGroupOfNames)(member=".$this->dn."))", array("cn"));
- while ($ldap->fetch()){
- $og= new ogroup($this->config, $ldap->getDN());
- unset($og->member[$this->dn]);
- $og->save ();
- }
- */
}
-
- /* Save data to object */
+ //! Save our data
+ /*!
+ Save POST data to object \n
+ This gives us the possibility to leave a tab, without losing our typed informations\n
+ \n
+ Read the POST fields for the parameters and saves their info the the class\n
+ */
function save_object()
{
- if (isset($_POST['cn'])){
+ if (isset($_POST['phoneparameters'])){
plugin::save_object();
}
+ /* read out post data, and assign it to the parameters */
+ /* And or delete */
+ foreach($_POST as $name=>$value){
+
+ /* Test if there is a variable begining with "del" */
+ if(preg_match("/del/",$name)){
+
+ /* Extract entry id to delete */
+ $nr = str_replace("del","",$name) ;
+
+ /* unset entry */
+ unset($this->goFonMacroParameter[$nr]);
+
+ }elseif(preg_match("/number/",$name)){
+
+ /* Set Post vars */
+ $key = $_POST[$name];
+
+ $this->goFonMacroParameter[$key]['var'] = $_POST["var".$key];
+ $this->goFonMacroParameter[$key]['name'] = $_POST["varname".$key];
+ $this->goFonMacroParameter[$key]['type'] = $_POST["vartype".$key];
+ $this->goFonMacroParameter[$key]['default']= $_POST["default".$key];
+ }
+ }
+
}
- /* Check values */
+ //! Checks given values
+ /*!
+ Check values\n
+ If a user enters an invalid value, then this function will output an error msg\n
+ (In better words :prepare the errormessages that will be put out )\n
+ */
function check()
{
$message = array();
-
+
foreach($this->attributes as $attr){
if(chkacl($this->acl,$attr)){
- $str = sprintf( _("Insufficient permissions, can't change attribute '%s' in goFonMacro"),$attr) ;
+ $str = sprintf( _("Insufficient permissions, can't change attribute '%s' in goFonMacro."),$attr) ;
return(array($str));
- }
}
+ }
+
+
+ foreach($this->goFonMacroParameter as $key=>$val){
+ if((strstr($val['default'],"!"))||(strstr($val['default'],"#"))) {
+ $message[] = sprintf(_("The parameter %s contains invalid char. '!,#' is used as delimiter"),$val['name']);
+ }
+ switch($val['type']){
+ case 'bool' : $possible = array("","0","1");
+ if(!in_array($val['default'],$possible)) {
+ $message[] = sprintf(_("The parameter %s has incorrect value for type bool."),$val['name']);
+ };break;
+ case 'string' :
+ case 'combo' :
+ default : ;
+
+ }
+ }
return $message;
}
-
- /* Save to LDAP */
+ //! Save changes to openldap
+ /*!
+ Save to LDAP
+ This function saves given attributes to the ldap
+ */
function save()
{
/* Post checks */
- $this->execute();
plugin::save();
$this->attrs['goFonMacroParameter']=array();
-
+
foreach($this->goFonMacroParameter as $key=>$fonpara){
- $this->attrs['goFonMacroParameter'][]=$key."!".$fonpara['name']."!".$fonpara['type']."!".$fonpara['default'];
+ $this->attrs['goFonMacroParameter'][]=$key."!".base64_encode($fonpara['name'])."!".$fonpara['type']."!".$fonpara['default'];
+ }
+
+ if($this->para_count != count($this->attrs['goFonMacroParameter'])){
+ print_red(_("Parameter count of the macro changed, you must update each user which are using this macro '%s'."),$this->dn);
}
unset($this->attrs['base']);