<?php
class blocklist extends plugin
{
  /* Definitions */
  var $plHeadline= "FAX Blocklists";
  var $plDescription= "This does something";

  /* CLI vars */
  var $cli_summary= "Handling of GOfax block lists";
  var $cli_description= "Some longer text\nfor help";
  var $cli_parameters= array("eins" => "Eins ist toll", "zwei" => "Zwei ist noch besser");

  /* blocklist attributes */
  var $cn               = "";
  var $description      = "";
  var $type             = "";
  var $base             = "";

  var $goFaxBlocklist   = array();
  var $blocklists       = array();
  var $attributes       = array("cn", "description");
  var $objectclasses    = array();
  var $DivListBlocklist = NULL;

  function blocklist ($config, $ui)
  {
    /* Init class */
    $this->ui     = $ui;
    $this->dn     = "";
    $this->config = $config;
    $this->base = $_SESSION['CurrentMainBase']; 
    $this->DivListBlocklist = new divListBlocklist($this->config,$this);
    $this->set_acl_category("gofaxlist");
    $this->set_acl_base($this->base);
  }

  function execute()
  {
    /* Call parent execute */
    plugin::execute();

    $_SESSION['LOCK_VARS_TO_USE'] = array("/^goFaxBlocklist_/","/^act$/","/^id$/","/^remove_multiple_blocklists/","/^item_selected/");

    /***************
      Init vars 
     ***************/

    /* Get global smarty instance */
    $smarty       = get_smarty();
    $s_action     = "";                       // Contains the action to proceed
    $s_entry      = "";                       // The value for s_action
    $base_back    = "";                       // The Link for Backbutton


    /***************
      Fetch posts 
     ***************/

    /* Test Posts */
    foreach($_POST as $key => $val){
      // Post for delete
      if(preg_match("/^goFaxBlocklist_del.*/",$key)){
        $s_action = "del";
        $s_entry  = preg_replace("/^goFaxBlocklist_del_/i","",$key);
        // Post for edit
      }elseif(preg_match("/^goFaxBlocklist_edit_.*/",$key)){
        $s_action="edit";
        $s_entry  = preg_replace("/^goFaxBlocklist_edit_/i","",$key);
        // Post for new
      }elseif(preg_match("/^goFaxBlocklist_new.*/",$key)){
        $s_action="new";
      }elseif(preg_match("/^remove_multiple_blocklists/",$key)){
        $s_action="del_multiple";
      }
    }

    if((isset($_GET['act']))&&($_GET['act']=="edit_entry")){
      $s_action ="edit";
      $s_entry  = $_GET['id'];
    }

    $s_entry  = preg_replace("/_.$/","",$s_entry);


    /***************
      Cancel some dialogs  
     ***************/

    /* Cancel dialog */
    if (isset($_POST['edit_cancel']) || 
        isset($_POST['delete_blocklist_cancel']) ||
        isset($_POST['delete_blocklist_confirm']) || 
        isset($_POST['delete_lock'])){

      del_lock ($this->dn);
      if(!isset($_POST['delete_blocklist_confirm'])){
        $this->clear_fields();
      }
      unset($_SESSION['objectinfo']);
    }


    /***************
      Create a new blocklist (dialog)
     ***************/

    /* Create new blocklist? */
    if ($s_action=="new"){
      $this->clear_fields();
      $this->dn= "new";
      plugin::plugin ($this->config, $this->dn);
    }


    /***************
      Edit blocklist 
     ***************/

    /* Edit selected blocklist? */
    if (($s_action=="edit") && (empty($this->dn))){
      $this->clear_fields();
      $this->dn=$this->blocklists[$s_entry]['dn']; 
      if (($user= get_lock($this->dn)) != ""){
        $_SESSION['dn']= $this->dn;
        //$this->dn ="";
        return(gen_locked_message($user, $this->dn));
      } else {
# Lock this dn for editing
        add_lock ($this->dn, $this->ui->dn);

        plugin::plugin ($this->config, $this->dn);

        /* Load missing lists */
        if (in_array("goFaxSBlock",$this->attrs['objectClass'])){
          if(isset($this->attrs["goFaxSBlocklist"])){
            for ($i= 0; $i<$this->attrs["goFaxSBlocklist"]["count"]; $i++){
              $this->goFaxBlocklist[]= $this->attrs["goFaxSBlocklist"][$i];
            }
          }
          $this->type= 0;
        } elseif (in_array("goFaxRBlock",$this->attrs['objectClass'])){
          if(isset($this->attrs["goFaxRBlocklist"])){
            for ($i= 0; $i<$this->attrs["goFaxRBlocklist"]["count"]; $i++){
              $this->goFaxBlocklist[]= $this->attrs["goFaxRBlocklist"][$i];
            }
          }
          $this->type= 1;
        }
        $_SESSION['objectinfo']= trim($this->dn);
      }
    }


    /********************
      Delete MULTIPLE entries requested, display confirm dialog
     ********************/

    if ($s_action=="del_multiple"){

      $this->dns = array();
      $ids = $this->list_get_selected_items();

      if(count($ids)){
        foreach($ids as $id){
          $dn = $this->blocklists[$id]['dn'];
          if (($user= get_lock($dn)) != ""){
            return(gen_locked_message ($user, $dn));
          }
          $this->dns[$id] = $dn;
        }

        $dns_names = "<br><pre>";
        foreach($this->dns as $dn){
          add_lock ($dn, $this->ui->dn);
          $dns_names .= $dn."\n";
        }
        $dns_names .="</pre>";

        /* Lock the current entry, so nobody will edit it during deletion */
        $smarty->assign("info",     sprintf(_("You're about to delete the following blocklists(s) %s"), @LDAP::fix($dns_names)));
        $smarty->assign("multiple", true);
        return($smarty->fetch(get_template_path('remove.tpl', TRUE)));
      }
    }


    /********************
      Delete MULTIPLE entries confirmed
     ********************/

    /* Confirmation for deletion has been passed. Users should be deleted. */
    if (isset($_POST['delete_multiple_blocklist_confirm'])){

      /* Remove user by user and check acls before removeing them */
      foreach($this->dns as $key => $dn){
        $acl = $this->ui->get_permissions($dn, "blocklist/blocklist");
        if (preg_match('/d/', $acl)){
          $this->dn = $dn;
          $this->remove_from_parent();
        } else {
          print_red (sprintf(_("You are not allowed to delete the blocklist '%s'!"),$dn));
        }
        /* Remove lock file after successfull deletion */
        del_lock ($dn);
        unset($this->dns[$key]);
      }
      $this->reload();
    }


    /********************
      Delete MULTIPLE entries Canceled
     ********************/

    /* Remove lock */
    if(isset($_POST['delete_multiple_blocklist_cancel'])){
      foreach($this->dns as $key => $dn){
        del_lock ($dn);
        unset($this->dns[$key]);
      }
    }


    /***************
      Remove blocklist
     ***************/

    /* Delete blocklist requested */
    if ($s_action=="del"){
      $this->dn=$this->blocklists[$s_entry]['dn'];
      /* Check locking */
      if (($user= get_lock($this->dn)) != ""){
        $_SESSION['dn']= $this->dn;
        return(gen_locked_message($user, $this->dn));
      } else {
# Lock this dn for editing
        add_lock ($this->dn, $this->ui->dn);

        $smarty->assign("info", sprintf(_("You're about to delete the blocklist '%s'."), $this->dn));
        $smarty->assign("multiple", false);
        return($smarty->fetch(get_template_path('remove.tpl', TRUE)));
      }
    }


    /***************
      Remove blocklist confirmed
     ***************/

    /* Finally delete blocklist */
    if (isset($_POST['delete_blocklist_confirm'])){
      if ($this->acl_is_removeable()){
        $this->remove_from_parent();
        gosa_log ("Blocklist object'".$this->dn."' has been removed");
        $this->reload ();
      } else {
        print_red (_("You have no permission to remove this blocklist."));
      }
    }


    /***************
      Add numer to blocklist
     ***************/


    /* Handle interactions: add */
    if (isset($_POST['add_number']) && $_POST['number'] != ""){
      if (is_phone_nr($_POST['number']) || preg_match ("/^[\/0-9 ()\^\.\$+*-]+$/",$_POST['number'])){
        $this->addNumber ($_POST['number']);
      } else {
        print_red (_("Please specify a valid phone number."));
      }
    }


    /***************
      Delete number from list
     ***************/

    /* Handle interactions: delete */
    if (isset($_POST['delete_number']) && count($_POST['numbers']) > 0){
      $this->delNumber ($_POST['numbers']);
    }


    /***************
      Edit finished
     ***************/

    /* What about finish? */
    if ((isset($_POST['edit_finish']) || isset($_POST['edit_apply'])) && (!empty($this->dn))){
      $message= $this->check();
      $this->remove_lock();

      /* No errors, save object */
      if (count ($message) == 0){

        /* Perpare 'dn' in case of new entries */
        if ($this->dn == "new"){
          $this->dn= "cn=$this->cn,ou=gofax,ou=systems,".$this->base;
        }

        $this->save ();
        gosa_log ("Blocklist object'".$this->dn."' has been saved");
      
        if (!isset($_POST['edit_apply'])){
          $this->dn= "";
          del_lock ($this->ui->dn);
          unset($_SESSION['objectinfo']);
        }
      } else {
        /* Errors found, show message */
        show_errors ($message);
      }
    }


    /***************
      Object currently in edit  
     ***************/

    if($this->dn){

      $dn = $this->dn;
  
      /* set Account states, this is nescessary for get_allowed_bases */
      $this->initially_was_account= true;
      $this->is_account = true;
      if($dn == "new"){
        $dn = "cn=dummy,ou=gofax,ou=systems,".$this->base; 
        $this->initially_was_account= false;
      }

      $this->set_acl_category("gofaxlist");
      $this->set_acl_base($dn);

      /* Base select dialog */
      $once = true;
      foreach($_POST as $name => $value){
        if(preg_match("/^chooseBase/",$name) && $once){
          $once = false;
          $this->dialog = new baseSelectDialog($this->config,$this,$this->get_allowed_bases());
          $this->dialog->setCurrentBase($this->base);
        }
      }

      /* Dialog handling */
      if(is_object($this->dialog)){
        /* Must be called before save_object */
        $this->dialog->save_object();

        if($this->dialog->isClosed()){
          $this->dialog = false;
        }elseif($this->dialog->isSelected()){

          /* A new base was selected, check if it is a valid one */
          $tmp = $this->get_allowed_bases();
          if(isset($tmp[$this->dialog->isSelected()])){
            $this->base = $this->dialog->isSelected();
          }
          $this->dialog= false;

        }else{
          return($this->dialog->execute());
        }
      }

      /* Set base */
      if ($this->base == ""){
        if ($this->dn == "new"){
          $ui= get_userinfo();
          $this->base= dn2base($ui->dn);
        } else {
          $this->base= preg_replace ("/^[^,]+,[^,]+,[^,]+,/", "", $this->dn);
        }
      }

      /* Fill templating stuff */
      $smarty->assign("bases", $this->get_allowed_bases());

      $smarty->assign("base_select", $this->base);
      $smarty->assign("types", array(0 => _("send"), 1 => _("receive")));
      if ($this->dn == "new" || preg_match ("/,ou=incoming,/", $this->dn)){
        $smarty->assign("selectmode", "");
        $smarty->assign("mode", "");
        $smarty->assign("apply", "0");
      } else {
        $smarty->assign("selectmode", "disabled");
        $smarty->assign("mode", "readonly");
        $smarty->assign("apply", "1");
      }

      $tmp = $this->plInfo();
      foreach($tmp['plProvidedAcls'] as $name => $translation){
        $smarty->assign($name."ACL",$this->getacl($name));
      }

      foreach(array("cn", "description", "type", "goFaxBlocklist") as $val){
        $smarty->assign("$val", $this->$val);
      }

      /* Lock blocklist type for non new entries */
      $smarty->assign('typeACL',$this->getacl("type", ($this->dn != "new")));

      /* Show main page */
      return($smarty->fetch (get_template_path('generic.tpl', TRUE)));

    }else{

      /***************
        Divlist dialog 
       ***************/

      /* Check if there is a snapshot dialog open */
      $base = $this->DivListBlocklist->selectedBase;
      if($str = $this->showSnapshotDialog($base,$this->get_used_snapshot_bases())){
        return($str);
      }

      /* Display dialog with system list */
      $this->DivListBlocklist->parent = $this;
      $this->DivListBlocklist->execute();

      /* Add departments if subsearch is disabled */
      if(!$this->DivListBlocklist->SubSearch){
        $this->DivListBlocklist->AddDepartments($this->DivListBlocklist->selectedBase,3,1);
      }
      $this->reload();
      $this->DivListBlocklist->setEntries($this->blocklists);
      return($this->DivListBlocklist->Draw());
    }
  }


  function list_get_selected_items()
  {
    $ids = array();
    foreach($_POST as $name => $value){
      if(preg_match("/^item_selected_[0-9]*$/",$name)){
        $id   = preg_replace("/^item_selected_/","",$name);
        $ids[$id] = $id;
      }
    }
    return($ids);
  }


  /* Return departments, that will be included within snapshot detection */
  function get_used_snapshot_bases()
  {
    return(array("ou=gofax,ou=systems,". $this->DivListBlocklist->selectedBase));
  }


  /* Clear garbage from edited lists */
  function clear_fields()
  {
    $this->dn= "";
    $this->description= "";
    $this->cn= "";
    $this->base= $_SESSION['CurrentMainBase'];
    $this->goFaxBlocklist= array();
  }


  /* Reload the list of known blocklists */
  function reload()
  {
    /* Init some vars */
    $filter = $filter2      = "";
    $base                   = $this->DivListBlocklist->selectedBase;
    $Regex                  = $this->DivListBlocklist->Regex;
    $SubSearch              = $this->DivListBlocklist->SubSearch;
    $ShowSendBocklists      = $this->DivListBlocklist->ShowSendBocklists;
    $ShowReceiveBlocklists  = $this->DivListBlocklist->ShowReceiveBlocklists;
    $Flags                  = GL_SIZELIMIT;
    $res = $res2            = array();

    /* Append subsearch to Flags */
    if($SubSearch){
      $Flags |= GL_SUBSEARCH;
    }else{
      $base = "ou=gofax,ou=systems,".$base;
    }  

    /* Create filter */
    if ($ShowSendBocklists){
      $filter = "(&(objectClass=goFaxSBlock)(|(cn=".$Regex.")(goFaxSBlocklist=".$Regex.")))";
      $res= get_list($filter, "gofaxlist", $base,array("*"), $Flags);
    }
    if ($ShowReceiveBlocklists){
      $filter2= "(&(objectClass=goFaxRBlock)(|(cn=".$Regex.")(goFaxRBlocklist=".$Regex.")))";
      $res2= get_list($filter2, "gofaxlist", $base,array("*"), $Flags);
    }
   
    $this->blocklists = array_merge($res,$res2);

    /* appen && sort */
    $tmp=array();
    foreach($this->blocklists as $tkey => $val ){

      $acl = $this->ui ->get_permissions($base,"gofaxlist/blocklist");
      if(preg_match("/r/",$acl)){
        $tmp[strtolower($val['cn'][0]).$val['cn'][0]]=$val;
      }
    }
    ksort($tmp);
    $this->blocklists=array();
    foreach($tmp as $val){
      $this->blocklists[]=$val;
    }
    reset ($this->blocklists);
  }


  function remove_from_parent()
  {
    $ldap= $this->config->get_ldap_link();
    $ldap->rmDir($this->dn);
    show_ldap_error($ldap->get_error(), sprintf(_("Removing of blocklist with dn '%s' failed."),$this->dn));
    $this->clear_fields();
    $this->handle_post_events("remove");
  }


  /* Save data to object */
  function save_object()
  {
    $this->DivListBlocklist->save_object();

    /* Create a base backup and reset the
       base directly after calling plugin::save_object();
       Base will be set seperatly a few lines below */
    $base_tmp = $this->base;
    plugin::save_object();
    $this->base = $base_tmp;

    /* Save base, since this is no LDAP attribute */
    $tmp = $this->get_allowed_bases();
    if(isset($_POST['base'])){
      if(isset($tmp[$_POST['base']])){
        $this->base= $_POST['base'];
      }
    }

    foreach($this->attributes as $attr){
      if(isset($_POST[$attr]) && $this->acl_is_writeable($attr)){
        $this->$attr = $_POST[$attr];
      }
    }
    if(isset($_POST['type']) && $this->acl_is_writeable("type",($this->dn != "new"))){
      $this->type = $_POST['type'];
    }
  }


  /* Check values */
  function check()
  {
    /* Call common method to give check the hook */
    $message= plugin::check();

    /* Permissions for that base? */
    if ($this->base != ""){
      $new_dn= "cn=".$this->cn.",ou=gofax,ou=systems,".$this->base;
    } else {
      $new_dn= $this->dn;
    }

    /* check syntax: must cn */
    if ($this->cn == ""){
      $message[]= _("Required field 'Name' is not set.");
    } else {
      if (!is_uid($this->cn)){
        $message[]= _("Required field 'Name' contains invalid characters");
      }
      if ($this->dn == 'new'){
        $ldap= $this->config->get_ldap_link();
        $ldap->cd ("ou=gofax,ou=systems,".$this->config->current["BASE"]);
        $ldap->search ("(&(|(objectClass=goFaxSBlock)(objectClass=goFaxRBlock))(cn=".$this->cn."))", array("cn"));
        if ($ldap->count() != 0){
          $message[]= _("Specified name is already used.");
        }
      }
    }

    return $message;
  }


  /* Save to LDAP */
  function save()
  {
    plugin::save();


    /* Type selection */
    if ($this->type == 0){
      $type= "goFaxSBlock";
    } else {
      $type= "goFaxRBlock";
    }

    /* Add list */
    $this->attrs['objectClass']= $type;
    if (count($this->goFaxBlocklist)){
      $this->attrs["$type"."list"]= $this->goFaxBlocklist;
    }

    /* Write back to ldap */
    $ldap= $this->config->get_ldap_link();
    $ldap->cd($this->base);
    $ldap->search("cn=$this->cn",array("cn"));
    $ldap->cat($this->dn, array('dn'));
    $a= $ldap->fetch();

    if (count($a)){
      if (!isset($this->attrs["$type"."list"])){
        $this->attrs["$type"."list"]= array();
      }
      $ldap->cd($this->dn);
      $this->cleanup();
      $ldap->modify($this->attrs);
      $this->handle_post_events("modify");
    } else {
      $ldap->cd($this->config->current['BASE']);
      $ldap->create_missing_trees(preg_replace('/^[^,]+,/', '', $this->dn));
      $ldap->cd($this->dn);
      $ldap->add($this->attrs);
      $this->handle_post_events("add");
    }
    show_ldap_error($ldap->get_error(), sprintf(_("Saving of blocklist with dn '%s' failed."),$this->dn));
  }


  /* Add number */
  function addNumber($number)
  {
    if (!in_array($number, $this->goFaxBlocklist)){
      $this->goFaxBlocklist[]= $number;
      sort($this->goFaxBlocklist);
    }
  }


  /* Remove number from list */
  function delNumber($numbers)
  {
    $tmp= array();
    foreach ($this->goFaxBlocklist as $val){
      if (!in_array($val, $numbers)){
        $tmp[]= $val;
      }
    }
    $this->goFaxBlocklist= $tmp;
  }


  /* Delete lock */
  function remove_lock()
  {
    if (isset($this->dn)){
      del_lock ($this->dn);
    }
  }

  /* Return plugin informations for acl handling */
  function plInfo()
  {
    return (array(  
          "plShortName"       => _("Fax"),
          "plDescription"     => _("Fax blocklists"),
          "plSelfModify"      => FALSE,
          "plDepends"         => array(),

          "plPriority"    => 0,
          "plSection"     => array("administration" => _("FAX Blocklists")),
          "plCategory"    => array("gofaxlist"      => array("description" => _("Fax blocklists"),
                                                             "objectClass" => array("goFaxRBlock","goFaxSBlock"))),
          "plProvidedAcls" => array(
            "cn"              => _("Name"),
            "description"     => _("Description"),
            "base"            => _("Base"),
            "goFaxBlocklist"  => _("Blocklist"),
            "type"            => _("Blocklist type"))
          ));
  }

}
// vim:tabstop=2:expandtab:shiftwidth=2:filetype=php:syntax:ruler:
?>