plugins/gofon/macro/class_gofonMacro.inc

   1 <?php
   2
   3 //!  The Phone Macro Class: Handles Macro Contents, and some attributes.
   4 /*!
   5      This class handles the basic information about phone macros, like
   6      cn base description displayName goFonMacroContent goFonMacroVisible
   7
   8      This is not the only Class that manages phone Macros, there ist also the class_goFonMacroParameter.
   9 */
  10 class macro extends plugin
  11 {
  12   /*! CLI vars */
  13   var $cli_summary= "Handling of GOsa's macro object";
  14   /*! CLI vars */
  15   var $cli_description= "Some longer text\nfor help";
  16   /*! CLI vars */
  17   var $cli_parameters= array("eins" => "Eins ist toll", "zwei" => "Zwei ist noch besser");
  18
  19   /*! Macro attributes,  */
  20   var $generate_error= "";
  21
  22   /*! The name of the Macro in the openldap drirectory */
  23   var $cn               = "";
  24
  25   /*! Display error once */
  26   var $error_shown = false;
  27
  28   /*! This ist the variable that contains the description of the macro*/
  29   var $description      = "";
  30
  31   /*! The base of the macro, is used to save the macro in the correct directory tree */
  32   var $base             = "";
  33
  34   /*! This is the name of the macro which the enduser will see, instead of the cn */
  35   var $displayName      = "";
  36
  37   /*! Here is the macro content, the real macroscript */
  38   var $goFonMacroContent= "";
  39
  40   /*! To allow user to use this macro this var must be true, else false */
  41   var $goFonMacroVisible= 0;
  42
  43   /*! attribute list for save action */
  44   var $attributes     = array("cn","base", "description","displayName","goFonMacroContent","goFonMacroVisible");
  45
  46   var $orig_cn = "";
  47   /*! Objectclasses that this calls handles */
  48   var $objectclasses  = array("top", "goFonMacro");
  49
  50   var $goFonHomeServers = array(); // Contains all available asterisk database server
  51
  52   //! The Konstructor
  53   /*!  Konstructor, load class with  attributes of the given dn*/
  54   function macro ($config, $dn= NULL, $parent= NULL)
  55   {
  56     plugin::plugin ($config, $dn, $parent);
  57
  58     /* This is always an account */
  59     $this->is_account= TRUE;
  60
  61     /* Edit or new one ?*/
  62     if ($this->dn == "new"){
  63       if(isset($_SESSION['CurrentMainBase'])){
  64         $this->base = $_SESSION['CurrentMainBase'];
  65       }else{
  66         $ui= get_userinfo();
  67         $this->base= dn2base($ui->dn);
  68       }
  69     } else {
  70       $this->orig_cn=$this->cn;
  71       $this->base= preg_replace ("/^[^,]+,[^,]+,[^,]+,[^,]+,[^,]+,/", "", $this->dn);
  72     }
  73
  74     /* Check server configurations
  75      * Load all server configuration in $this->goFonHomeServers if available
  76      */
  77     $a_SETUP= array();
  78     if(array_key_exists('config',$_SESSION) &&
  79        array_key_exists('SERVERS',$_SESSION['config']->data) &&
  80        count($_SESSION['config']->data['SERVERS']['FON']) &&
  81        array_key_exists('FON',$_SESSION['config']->data['SERVERS'])) {
  82
  83       /* Set available server */
  84       $this->goFonHomeServers = $_SESSION['config']->data['SERVERS']['FON'];
  85
  86       /* Remove default entry, not necessary here */
  87       if(isset($this->goFonHomeServers[0])){
  88         unset($this->goFonHomeServers[0]);
  89       }
  90     }
  91
  92     /* Load acl */
  93     $ui       = get_userinfo();
  94     $acl      = get_permissions ($ui->dn, $ui->subtreeACL);
  95     $this->acl= get_module_permission($acl, "goFonMacro", $ui->dn);
  96   }
  97
  98
  99   /*!  Execute this plugin */
 100   function execute()
 101   {
 102     /* Call parent execute */
 103     plugin::execute();
 104
 105     /* Variables */
 106     $vars       = "";
 107     $tmp        = array();
 108     $number = 0;
 109
 110     /* Base select dialog */
 111     $once = true;
 112     foreach($_POST as $name => $value){
 113       if(preg_match("/^chooseBase/",$name) && $once){
 114         $once = false;
 115         $this->dialog = new baseSelectDialog($this->config,$this->allowedBasesToMoveTo());
 116         $this->dialog->setCurrentBase($this->base);
 117       }
 118     }
 119
 120     /* Dialog handling */
 121     if(is_object($this->dialog)){
 122       /* Must be called before save_object */
 123       $this->dialog->save_object();
 124
 125       if($this->dialog->isClosed()){
 126         $this->dialog = false;
 127       }elseif($this->dialog->isSelected()){
 128         $this->base = $this->dialog->isSelected();
 129         $this->dialog= false;
 130       }else{
 131         return($this->dialog->execute());
 132       }
 133     }
 134
 135     /* Fill templating stuff */
 136     $smarty= get_smarty();
 137     $smarty->assign("bases", $this->config->idepartments);
 138
 139     /* Assign all vars to Smarty */
 140     foreach($this->attributes as $ar){
 141       $smarty->assign($ar, $this->$ar);
 142       $smarty->assign($ar."ACL", chkacl($this->acl,$ar));
 143     }
 144     /* Checkboxes */
 145     $smarty->assign("base_select", $this->base);
 146     $smarty->assign("vars", $vars);
 147
 148     if($this->goFonMacroVisible){
 149       $smarty->assign("goFonMacroVisibleChecked"," checked ");
 150     }else{
 151       $smarty->assign("goFonMacroVisibleChecked","");
 152     }
 153
 154     if(isset($_POST['goFonMacroVisible'])) {
 155       $this->goFonMacroVisible= 1 ;
 156       $smarty->assign("goFonMacroVisibleChecked"," checked ");
 157     }else  {
 158       if(isset($_POST['displayName'])){
 159         $this->goFonMacroVisible= 0 ;
 160         $smarty->assign("goFonMacroVisibleChecked","");
 161       }
 162     }
 163
 164     if($this->dn != "new"){
 165       $smarty->assign("disable_cn"," disabled ");
 166     }else{
 167       $smarty->assign("disable_cn","  ");
 168     }
 169
 170     /* Ensure that macro content is displayed correctly encoded */
 171     $smarty->assign("goFonMacroContent",htmlentities(utf8_decode ($this->goFonMacroContent)));
 172
 173     /* Show main page */
 174     return($smarty->fetch (get_template_path('generic.tpl', TRUE)));
 175   }
 176
 177
 178   /* This method check if all databases are reachable.
 179    *  Returns with error message or an empty string on success.
 180    *
 181    * - Is mysql extension available
 182    * - Is every server reachable
 183    * - Does the database exists/is accessible
 184    */
 185   function check_database_accessibility()
 186   {
 187     /* Check if mysql extension is available */
 188     if(!is_callable("mysql_pconnect")){
 189       return(_("Can't save any changes to asterisk database, there is currently no mysql extension available in your php setup."));
 190     }
 191
 192     /********************
 193      * Check all home server
 194      ********************/
 195     foreach($this->goFonHomeServers as $goFonHomeServer => $cfg_Current){
 196       $r_current    =  @mysql_pconnect($cfg_Current['SERVER'],$cfg_Current['LOGIN'],$cfg_Current['PASSWORD']);
 197       if(!$r_current){
 198         gosa_log(@mysql_error($r_current));
 199         return(sprintf(_("The MySQL home server '%s' isn't reachable as user '%s', check GOsa log for mysql error."),
 200               $cfg_Current['SERVER'],$cfg_Current['LOGIN']));
 201       }
 202       $db_current  =  @mysql_select_db($cfg_Current['DB'],$r_current);
 203       if(!$db_current){
 204         gosa_log(@mysql_error($r_current));
 205         mysql_close($r_current);
 206         return( sprintf(_("Can't select database '%s' on home server '%s'."),$cfg_Current['DB'],$cfg_Current['SERVER']));
 207       }
 208     }
 209   }
 210
 211
 212   /* Remove current macro from all asterisk server.
 213    * First of all check if we have access to all databases.
 214    * - Remove old entries
 215    */
 216   function remove_from_database($save)
 217   {
 218     /* Check if all databases are reachable */
 219     $str = $this->check_database_accessibility();
 220     if($str){
 221       return($str);
 222     }
 223
 224     /* Create query string */
 225     $context  = addslashes("macro-".$this->cn);
 226
 227     /* Remove current macro from each server available */
 228     if($save){
 229       foreach($this->goFonHomeServers as $dn => $Server){
 230         $query      = "DELETE FROM ".$Server['EXT_TABLE']." WHERE context='".$context."';";
 231         $r_current  =  @mysql_pconnect($Server['SERVER'],$Server['LOGIN'],$Server['PASSWORD']);
 232         $db_current =  @mysql_select_db($Server['DB'],$r_current);
 233         $res = @mysql_query($query,$r_current);
 234         if(!$res){
 235           gosa_log(@mysql_error($r_current));
 236           return(sprintf(_("Removing marco from '%s' failed. Check GOsa log for mysql error."),$Server['SERVER']));
 237         }
 238         @mysql_close($r_current);
 239       }
 240     }
 241   }
 242
 243
 244   /* Add current macro to all asterisk server.
 245    * First of all check if we have access to all databases.
 246    * - Remove old entries
 247    * - Add new entries
 248    */
 249   function add_to_database($save)
 250   {
 251     /* Check if all databases are reachable */
 252     $str = $this->check_database_accessibility();
 253     if($str){
 254       return($str);
 255     }
 256
 257     /* Remove old entries first. Else we got duplicated entries */
 258     $str = $this->remove_from_database($save);
 259     if($str){
 260       return($str);
 261     }
 262
 263     /* Create query string */
 264     $context      = "macro-".$this->cn;
 265
 266     /************
 267      * Parse Macro content
 268      ************/
 269     $sql =
 270       "INSERT INTO %TABLENAME% ".
 271       " (context,exten,priority,app,appdata) ".
 272       " VALUES ";
 273
 274     $a_contentLines = split("\n",$this->goFonMacroContent);
 275     foreach($a_contentLines as $i_linenum => $s_linestr){
 276
 277       /* Remove the 'exten => ' string in front of the macro content line
 278        *  example line  'exten => s,2,GotoIf(${ARG3}?3:5)'
 279        * Remove comments introduced by ;
 280        * Skip empty lines
 281        */
 282       $s_linestr = preg_replace ("/^.*=\> /","",$s_linestr);
 283       $s_linestr = preg_replace("/;.*$/","",$s_linestr) ;
 284       $s_linestr = trim($s_linestr);
 285       if(empty($s_linestr)){
 286         continue;
 287       }
 288
 289       /* A line that passes the check above should look like this
 290        *  s,1,SetLanguage(de)
 291        * 3 parts seperated by ,
 292        * If there are more or less parts, abort.
 293        * The preg_replace exclude parameters from split ..
 294        */
 295       $tmp  = split(",", $s_linestr,3);
 296
 297       /* Check if there are exactly 2 , */
 298       if(substr_count($s_linestr,",") !=2){
 299         return(sprintf(_("More than two ',' given in line : '%s'. Remember that parameters are seperated by '|'."),$i_linenum));
 300       }
 301       /* Multiple () are not supproted currently ... */
 302       if(substr_count($s_linestr,"(") >1 ){
 303         return(sprintf(_("More than one '(' is currently not supported. Line : '%s'."),$i_linenum));
 304       }
 305       if(substr_count($s_linestr,")") >1 ){
 306         return(sprintf(_("More than one ')' is currently not supported. Line : '%s'."),$i_linenum));
 307       }
 308       /* Check if there is an application given */
 309       if(empty($tmp[1])){
 310         return(sprintf(_("There is no application given in line : '%s'."),$i_linenum));
 311       }
 312       /* Check if there is an extension given */
 313       if(empty($tmp[0])){
 314         return(sprintf(_("There is no extension type given in line : '%s'."),$i_linenum));
 315       }
 316
 317       /* Create extension entry for current line
 318        *  and add this line to an array that will be inserted
 319        *  to each database.
 320        */
 321       $exten  = addslashes($tmp[0]);
 322       $prio   = addslashes($tmp[1]);
 323       $app    = addslashes(preg_replace("/\(.*\).*$/","",$tmp[2]));
 324       $para   = addslashes(preg_replace("/^.*\(/","",$tmp[2]));
 325       $para   = preg_replace("/\).*$/","",$para);
 326       $sql.= " ('".$context."','".$exten."','".$prio."','".$app."','".$para."'),";
 327     }
 328
 329     /* Remove last , from query string */
 330     $sql = preg_replace("/,$/","",$sql);
 331
 332     /* Save current changes to the database */
 333     if($save){
 334
 335       /* Macro are spread to each asterisk server */
 336       foreach($this->goFonHomeServers as $dn => $cfg){
 337         $r_con  = @mysql_pconnect($cfg['SERVER'],$cfg['LOGIN'],$cfg['PASSWORD']);
 338         $db     = @mysql_select_db($cfg['DB'],$r_con);
 339         $query  = preg_replace("/%TABLENAME%/",$cfg['EXT_TABLE'],$sql);
 340         $res    = @mysql_query($query,$r_con);
 341         if(!$res){
 342           gosa_log(@mysql_error($r_con));
 343           return(sprintf(_("Insert of new macro failed for server '%s'."),$cfg['SERVER']));
 344         }
 345         @mysql_close($r_con);
 346       }
 347     }
 348   }
 349
 350
 351   /*! Save data to object */
 352   function save_object()
 353   {
 354     if (isset($_POST['displayName'])){
 355       plugin::save_object();
 356
 357       /* The cn can't be changed if this entry is not new */
 358       if($this->dn!= "new"){
 359         $this->cn = $this->orig_cn;
 360       }
 361     }
 362   }
 363
 364
 365   /*! Check values */
 366   function check()
 367   {
 368     /* Call common method to give check the hook */
 369     $message= plugin::check();
 370
 371     if(!count($this->goFonHomeServers)){
 372       $message[] = _("There must be at least one server with an asterisk database to save this phone macro.");
 373     }
 374
 375     /* Check if insert/replace is possible and all servers are available */
 376     $str = $this->add_to_database(false);
 377     if($str){
 378       $message[] = $str;
 379     }
 380
 381     /* Check if cn is already used  */
 382     if(($this->dn=="new")||($this->orig_cn!=$this->cn)){
 383       $ldap = $this->config->get_ldap_link();
 384       $ldap->search("(&(objectClass=goFonMacro)(cn=".$this->cn."))",array("cn"));
 385       if($ldap->count()>0){
 386         $message[]=sprintf(_("The given cn '%s' already exists."),$this->cn);
 387       }
 388     }
 389
 390     /* Check if display name is set */
 391     if(empty($this->displayName)){
 392       $message[] = _("You must specify the 'Display Name' in order to save this macro");
 393     }
 394     /* CN is restricted to 20 chars */
 395     if(strlen("Makro-".$this->cn)>20 ){
 396       $message[]=_("The given cn is too long, to create a Makro entry, maximum 20 chars.");
 397     }
 398
 399     /* Check permissions */
 400     foreach($this->attributes as $attr){
 401       if(chkacl($this->acl,"edit")){
 402         $str =  sprintf( _("Insufficient permissions, can't change attribute '%s' in goFonMacro"),$attr) ;
 403         return(array($str));
 404       }
 405     }
 406
 407     /* Macro content must be smaller than 100 lines */
 408     if(count(split("\n",$this->goFonMacroContent))>100){
 409       $message[] = _("Makro length must be lower than 100 lines");
 410     }
 411
 412     return $message;
 413   }
 414
 415
 416   /*! Remove makro from all given databases
 417    *   and ldap too.
 418    */
 419   function remove_from_parent()
 420   {
 421     $ldap= $this->config->get_ldap_link();
 422
 423     /* Skip remove if this macro is still in use */
 424     $res = $ldap->search("(&(objectClass=goFonAccount)(objectClass=gosaAccount)(goFonMacro=*))", array("goFonMacro"));
 425     while ($val = $ldap->fetch()){
 426       if(strstr($val['goFonMacro'][0],$this->dn)){
 427         print_red(_("This macro is still in use. To delete this Macro ensure that nobody has selected it."));
 428         return false;
 429       }
 430     }
 431
 432     /* Try to remove from database */
 433     if(count($this->goFonHomeServers)){
 434       $str = $this->remove_from_database(true);
 435       if($str){
 436         print_red($str);
 437       }
 438     }else{
 439       print_red(_("Could not remove the macro entry from asterisk databases. Please check your asterisk database configurations and remove this entry from database manually, if necessary."));
 440     }
 441
 442     /* Remove phone macro */
 443     $ldap->rmDir($this->dn);
 444     show_ldap_error($ldap->get_error(), _("Removing phone macro failed"));
 445
 446     /* Delete references to object groups */
 447     $ldap->cd ($this->config->current['BASE']);
 448     $ldap->search ("(&(objectClass=gosaGroupOfNames)(member=".$this->dn."))", array("cn"));
 449     while ($ldap->fetch()){
 450       $og= new ogroup($this->config, $ldap->getDN());
 451       unset($og->member[$this->dn]);
 452       $og->save ();
 453       show_ldap_error($ldap->get_error(), _("Removing phone macro reverences failed"));
 454     }
 455   }
 456
 457
 458   /*! Save to LDAP */
 459   function save()
 460   {
 461     /* Post checks */
 462     $this->execute();
 463
 464     plugin::save();
 465     unset($this->attrs['base']);
 466
 467     /* Try to add entries to databases */
 468     $str = $this->add_to_database(true);
 469     if($str){
 470       print_red($str);
 471     }else{
 472       /* Write back to ldap */
 473       $ldap= $this->config->get_ldap_link();
 474       $ldap->cat($this->dn, array('dn'));
 475       $a= $ldap->fetch();
 476
 477       if (count($a)){
 478         $ldap->cd($this->dn);
 479         $this->cleanup();
 480         $ldap->modify ($this->attrs);
 481
 482         $this->handle_post_events("modify");
 483       } else {
 484         $ldap->cd($this->config->current['BASE']);
 485         $ldap->create_missing_trees(preg_replace('/^[^,]+,/', '', $this->dn));
 486         $ldap->cd($this->dn);
 487         $ldap->add($this->attrs);
 488         $this->handle_post_events("add");
 489       }
 490       show_ldap_error($ldap->get_error(), _("Saving phone macro failed"));
 491     }
 492   }
 493
 494 }
 495 // vim:tabstop=2:expandtab:shiftwidth=2:filetype=php:syntax:ruler:
 496 ?>