Code

df8c51e78fba7c40606b8c74a0adce06897cbea5
[gosa.git] / plugins / admin / departments / class_departmentGeneric.inc
1 <?php
2 /*
3   This code is part of GOsa (https://gosa.gonicus.de)
4   Copyright (C) 2003  Cajus Pollmeier
6   This program is free software; you can redistribute it and/or modify
7   it under the terms of the GNU General Public License as published by
8   the Free Software Foundation; either version 2 of the License, or
9   (at your option) any later version.
11   This program is distributed in the hope that it will be useful,
12   but WITHOUT ANY WARRANTY; without even the implied warranty of
13   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14   GNU General Public License for more details.
16   You should have received a copy of the GNU General Public License
17   along with this program; if not, write to the Free Software
18   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
19  */
21 class department extends plugin
22 {
23         /* department attributes */
24         var $ou= "";
25         var $description= "";
26         var $base= "";
27         var $st= "";
28         var $l= "";
29         var $postalAddress= "";
30         var $businessCategory= "";
31         var $telephoneNumber= "";
32         var $facsimileTelephoneNumber= "";
33         var $orig_dn= "";
34         var $is_administrational_unit= false;
35         var $gosaUnitTag= "";
37         var $rec_dst=false;     // Destination for recursive move
38         var $rec_src=false;     // Source for recursive move 
39         var $rec_cpy=false;     // Is recursive move requested ? 
41         /* Headpage attributes */
42         var $last_dep_sorting= "invalid";
43         var $departments= array();
45   var $must_be_tagged = false;
47         /* attribute list for save action */
48         var $attributes= array("ou", "description", "businessCategory", "st", "l", "postalAddress",
49                         "telephoneNumber", "facsimileTelephoneNumber", "gosaUnitTag");
50         var $objectclasses= array("top", "gosaDepartment", "organizationalUnit");
52         function department ($config, $dn)
53         {
55                 plugin::plugin($config, $dn);
56                 $this->is_account= TRUE;
57                 $this->ui= get_userinfo();
58                 $this->dn= $dn;
59                 $this->orig_dn= $dn;
60                 $this->config= $config;
62                 /* Set base */
63                 if ($this->dn == "new"){
64                         $ui= get_userinfo();
65                         if(isset($_SESSION['CurrentMainBase'])){
66                                 $this->base= $_SESSION['CurrentMainBase'];
67                         }else{
68                                 $this->base= dn2base($ui->dn);
69                         }
70                 } else {
71                         $this->base= preg_replace ("/^[^,]+,/", "", $this->dn);
72                 }
74                 /* set permissions */
75                 $ui= get_userinfo();
76                 $acl= get_permissions ($ui->dn, $ui->subtreeACL);
77                 $this->acl= get_module_permission($acl, "department", $ui->dn);
79                 /* Is administrational Unit? */
80                 if ($dn != "new" && in_array_ics('gosaAdministrativeUnit', $this->attrs['objectClass'])){
81                         $this->is_administrational_unit= true;
82                 }
83         }
85         function execute()
86         {
87                 /* Call parent execute */
88                 plugin::execute();
90                 /* Reload departments */
91                 $this->config->get_departments($this->dn);
92                 $this->config->make_idepartments();
93                 $smarty= get_smarty();
95                 /* Base select dialog */
96                 $once = true;
97                 foreach($_POST as $name => $value){
98                         if(preg_match("/^chooseBase/",$name) && $once){
99                                 $once = false;
100                                 $this->dialog = new baseSelectDialog($this->config);
101                                 $this->dialog->setCurrentBase($this->base);
102                         }
103                 }
105                 /* Dialog handling */
106                 if(is_object($this->dialog)){
107                         /* Must be called before save_object */
108                         $this->dialog->save_object();
110                         if($this->dialog->isClosed()){
111                                 $this->dialog = false;
112                         }elseif($this->dialog->isSelected()){
113                                 $this->base = $this->dialog->isSelected();
114                                 $this->dialog= false;
115                         }else{
116                                 return($this->dialog->execute());
117                         }
118                 }
120                 /* Hide all departments, that are subtrees of this department */
121                 $bases  = $this->config->idepartments;
122                 if(($this->dn == "new")||($this->dn == "")){
123                         $tmp = $bases;
124                 }else{
125                         $tmp    = array();      
126                         foreach($bases as $dn=>$base){
127                                 $fixed = str_replace("/","\\",$this->dn);
128                                 /* Only attach departments which are not a subtree of this one */
129                                 if(!preg_match("/".$fixed."/",$dn)){
130                                         $tmp[$dn]=$base;
131                                 }
132                         }
133                 }
134                 $smarty->assign("bases", $tmp);
136                 foreach ($this->attributes as $val){
137                         $smarty->assign("$val", $this->$val);
138                         $smarty->assign("$val"."ACL", chkacl($this->acl, "$val"));
139                 }
140     $smarty->assign("baseACL", chkacl($this->acl,"base"));
141                 $smarty->assign("base_select", $this->base);
143                 /* Set admin unit flag */
144                 if ($this->is_administrational_unit) {
145                         $smarty->assign("unitTag", "checked");
146                 } else {
147                         $smarty->assign("unitTag", "");
148                 }
149                 $smarty->assign("unitTag"."ACL", chkacl($this->acl, "unitTag"));
151                 return($smarty->fetch (get_template_path('generic.tpl', TRUE)));
152         }
154         function clear_fields()
155         {
156                 $this->dn= "";
157                 $this->base= "";
158                 $this->acl= "#none#";
160                 foreach ($this->attributes as $val){
161                         $this->$val= "";
162                 }
163         }
165         function remove_from_parent()
166         {
167                 $ldap= $this->config->get_ldap_link();
168                 $ldap->cd ($this->dn);
169                 $ldap->recursive_remove();
170                 show_ldap_error($ldap->get_error(), _("Removing department failed"));
172                 /* Optionally execute a command after we're done */
173                 $this->handle_post_events('remove');
174         }
176         function must_be_tagged()
177         {
178                 return $this->must_be_tagged;
179         }
181         function am_i_moved()
182         {
183                 return $this->rec_cpy;
184         }
187         /* Save data to object */
188         function save_object()
189         {
190                 if (isset($_POST['base'])){
191                         plugin::save_object();
193                         /* Save base, since this is no LDAP attribute */
194                         if (chkacl($this->acl, "create") == ""){
195                                 $this->base= $_POST['base'];
196                         }
198                         /* Save tagging flag */
199                         if (chkacl($this->acl, "unitTag") == ""){
200                                 if (isset($_POST['unitTag'])){
201                                         $this->is_administrational_unit= true;
202                                 } else {
203                                         $this->is_administrational_unit= false;
204                                 }
205                         }
206                 }
207         }
210         /* Check values */
211         function check()
212         {
213                 /* Call common method to give check the hook */
214                 $message= plugin::check();
216                 /* Permissions for that base? */
217                 //      $this->dn= "ou=$this->ou,".$this->base;
218                 if (chkacl($this->acl, "create") != ""){
219                         $message[]= _("You have no permissions to create a department on this 'Base'.");
220                 }
222                 /* Check for presence of this department */
223                 $ldap= $this->config->get_ldap_link();
224                 $attrs= $ldap->cat ($this->dn, array('dn'));
225                 if ($this->orig_dn == "new" && !($attrs === FALSE)){
226                         $message[]= _("Department with that 'Name' already exists.");
227                 } elseif ($this->orig_dn != $this->dn && !($attrs === FALSE)){
228                         $message[]= _("Department with that 'Name' already exists.");
229                 }
231                 /* All required fields are set? */
232                 if ($this->ou == ""){
233                         $message[]= _("Required field 'Name' is not set.");
234                 }
235                 if ($this->description == ""){
236                         $message[]= _("Required field 'Description' is not set.");
237                 }
239                 /* Validate and modify - or: spaghetti rules! */
240                 $SkipNames = array(     "incoming","apps","systems","fai","config",     
241                                 preg_replace("/ou=(.*),/","\\1",get_people_ou()),
242                                 preg_replace("/ou=(.*),/","\\1",get_groups_ou())
243                                 );      
244                 foreach($SkipNames as $name){
245                         if ($this->ou == $name){
246                                 $message[]= sprintf(_("The field 'Name' contains the reserved word '%s'. Please choose another name."),$name);
247                         }
248                 }
251                 if (preg_match ('/[#+:=>\\\\\/]/', $this->ou)){
252                         $message[]= _("The field 'Name' contains invalid characters.");
253                 }
254                 if (!is_phone_nr($this->telephoneNumber)){
255                         $message[]= _("The field 'Phone' contains an invalid phone number.");
256                 }
257                 if (!is_phone_nr($this->facsimileTelephoneNumber)){
258                         $message[]= _("The field 'Fax' contains an invalid phone number.");
259                 }
261                 return $message;
262         }
265         /* Save to LDAP */
266         function save()
267         {
268                 $ldap= $this->config->get_ldap_link();
270                 /* Add tag objects if needed */
271                 if ($this->is_administrational_unit){
272       if(!in_array_ics("gosaAdministrativeUnit",$this->objectclasses)){
273                         $this->objectclasses[]= "gosaAdministrativeUnit";
274       }
275                         if ($this->gosaUnitTag == ""){
277                                 /* It's unlikely, but check if already used... */
278                                 $try= 5;
279                                 $ldap->cd($this->config->current['BASE']);
280                                 while ($try--){
282                                         /* Generate microtime stamp as tag */
283                                         list($usec, $sec)= explode(" ", microtime());
284                                         $time_stamp= preg_replace("/\./", "", $sec.$usec);
286                                         $ldap->search("(&(objectClass=gosaAdministrativeUnit)(gosaUnitTag=$time_stamp))",array("gosaUnitTag"));
287                                         if ($ldap->count() == 0){
288                                                 break;
289                                         }
290                                 }
291                                 if($try == 0) {
292                                         print_red(_("Fatal error: Can't find an unused tag to mark the administrative unit!"));
293                                         return;
294                                 }
295                                 $this->gosaUnitTag= preg_replace("/\./", "", $sec.$usec);
296                         }
297                 } else {
298                         $this->gosaUnitTag= "";
299                 }
301                 plugin::save();
303                 /* Remove tag information if needed */
304                 if (!$this->is_administrational_unit){
305                         $tmp= array();
307                         /* Remove gosaAdministrativeUnit from this plugin */
308                         foreach($this->attrs['objectClass'] as $oc){
309                                 if (!preg_match("/^gosaAdministrativeUnit$/i", $oc)){
310                                         $tmp[]= $oc;
311                                 }
312                         }
313                         $this->attrs['objectClass']= $tmp;
314                         if(isset($this->attrs['gosaUnitTag'])){
315                                 $this->attrs['gosaUnitTag']= array();
316                         }
317                 }
319                 /* Write back to ldap */
320                 $ldap= $this->config->get_ldap_link();
321                 $ldap->cat($this->dn, array('dn'));
322                 $a= $ldap->fetch();
323                 $ldap->cd($this->dn);
325                 if (count($a)){
326                         $this->cleanup();
327                         $ldap->modify ($this->attrs); 
329                         $this->handle_post_events('modify');
330                 } else {
331                         $ldap->add($this->attrs);
332                         $this->handle_post_events('add');
333                 }
334                 show_ldap_error($ldap->get_error(), _("Saving department failed"));
336     /* The parameter forces only to set must_be_tagged, and don't touch any objects 
337         This will be done later */
338     $this->tag_objects(true);
339     
340     /* Optionally execute a command after we're done */
341                 $this->postcreate();
342     return(true);
343         }
346   function ShowMoveFrame()
347   {
348     $smarty = get_smarty();
349     $smarty->assign("src","?plug=".$_GET['plug']."&PerformRecMove");
350     $smarty->assign("message","As soon as the move operation has finished, you can scroll down to end of the page and press the 'Continue' button to continue with the department management dialog.");
351     $display=  $smarty->fetch(get_template_path("dep_iframe.tpl",TRUE));
352     return($display);
353   }
355   function ShowTagFrame()
356   {
357     $smarty = get_smarty();
358     $smarty->assign("src","?plug=".$_GET['plug']."&TagDepartment");
359     $smarty->assign("message","As soon as the tag operation has finished, you can scroll down to end of the page and press the 'Continue' button to continue with the department management dialog.");
360     $display=  $smarty->fetch(get_template_path("dep_iframe.tpl",TRUE));
361     return($display);
362   }
364         /* Tag objects to have the gosaAdministrativeUnitTag */
365         function tag_objects($OnlySetTagFlag = false)
366         {
367     if(!$OnlySetTagFlag){
368       $smarty= get_smarty();
369       echo "<!-- headers.tpl-->".$smarty->fetch(get_template_path('headers.tpl'));
370       echo "<body style='background-image:none;margin:3px;color:black'>";
371       echo "<h3>".sprintf(_("Tagging '%s'."),"<i>".@LDAP::fix($this->dn)."</i>")."</h3>";
372     }
374                 $add= $this->is_administrational_unit;
375                 $len= strlen($this->dn);
376                 $ldap= $this->config->get_ldap_link();
377                 $ldap->cd($this->dn);
378                 if ($add){
379                         $ldap->search('(!(&(objectClass=gosaAdministrativeUnitTag)(gosaUnitTag='.
380                                                                 $this->gosaUnitTag.')))', array('dn'));
381                 } else {
382                         $ldap->search('objectClass=gosaAdministrativeUnitTag', array('dn'));
383                 }
384                 while ($attrs= $ldap->fetch()){
386                         /* Skip self */
387                         if ($attrs['dn'] == $this->dn){
388                                 continue;
389                         }
391                         /* Check for confilicting administrative units */
392                         $fix= true;
393                         foreach ($this->config->adepartments as $key => $tag){
394                                 /* This one is shorter than our dn, its not relevant... */
395                                 if ($len >= strlen($key)){
396                                         continue;
397                                 }
399                                 /* This one matches with the latter part. Break and don't fix this entry */
400                                 if (preg_match('/(^|,)'.normalizePreg($key).'$/', $attrs['dn'])){
401                                         $fix= false;
402                                         break;
403                                 }
404                         }
406       /* Fix entry if needed */
407       if ($fix){
408         if($OnlySetTagFlag){
409           $this->must_be_tagged =true;
410           return;
411         }
412                                 $this->handle_object_tagging($attrs['dn'], $this->gosaUnitTag, TRUE );
413                         }
414                 }
415     if(!$OnlySetTagFlag){
416       echo '<p class="seperator">&nbsp;</p>';
417       echo "<div style='width:100%;text-align:right;'><form name='form' method='post' action='?plug=".$_GET['plug']."' target='_parent'>
418         <br><input type='submit' name='back' value='"._("Continue")."'>
419         </form></div>";
420     }
421         }
424         /* Move/Rename complete trees */
425         function recursive_move($src_dn, $dst_dn,$force = false)
426         {
427     /* If force == false prepare to recursive move this object from src to dst 
428         on the next call. */
429                 if(!$force){
430                         $this->rec_cpy  = true;
431                         $this->rec_src  = $src_dn;
432                         $this->rec_dst  = $dst_dn;
433                 }else{
435       /* If this is called, but not wanted, abort */
436                         if(!$this->rec_cpy){ 
437                                 return;
438                         }
440                         $src_dn = $this->rec_src;
441                         $dst_dn = $this->rec_dst;
443                         /* Print header to have styles included */
444                         $smarty= get_smarty();
445                         echo "<!-- headers.tpl-->".$smarty->fetch(get_template_path('headers.tpl'));
446                         echo "<body style='background-image:none;margin:3px;color:black'>";
448                         echo "<h3>".sprintf(_("Moving '%s' to '%s'"),"<i>".$src_dn."</i>","<i>".$dst_dn."</i>")."</h3>";
451                         /* Check if the destination entry exists */
452                         $ldap= $this->config->get_ldap_link();
454                         /* Check if destination exists - abort */
455                         $ldap->cat($dst_dn, array('dn'));
456                         if ($ldap->fetch()){
457                                 trigger_error("Recursive_move $dst_dn already exists.",
458                                                 E_USER_WARNING);
459                                 echo sprintf("Recursive_move: '%s' already exists", $dst_dn)."<br>"; 
460                                 return (FALSE);
461                         }
463                         /* Perform a search for all objects to be moved */
464                         $objects= array();
465                         $ldap->cd($src_dn);
466                         $ldap->search("(objectClass=*)", array("dn"));
467                         while($attrs= $ldap->fetch()){
468                                 $dn= $attrs['dn'];
469                                 $objects[$dn]= strlen($dn);
470                         }
472                         /* Sort objects by indent level */
473                         asort($objects);
474                         reset($objects);
476                         /* Copy objects from small to big indent levels by replacing src_dn by dst_dn */
477                         foreach ($objects as $object => $len){
480                                 $src= str_replace("\\","\\\\",$object);
481                                 $dst= preg_replace("/".str_replace("\\","\\\\",$src_dn)."$/", "$dst_dn", $object);
482                                 $dst= str_replace($src_dn,$dst_dn,$object);
484                                 echo "<b>"._("Object").":</b> $src<br>";
486                                 if (!$this->copy($src, $dst)){
487                                         echo "<font color='#FF0000'><br>".sprintf(_("FAILED to copy %s, aborting operation"),$src)."</font>";
488                                         return (FALSE);
489                                 }
491                                 flush();
492                         }
494                         /* Remove src_dn */
495                         $ldap->cd($src_dn);
496                         $ldap->recursive_remove();
497                         $this->rec_src = $this->rec_dst = "";
498                         $this->rec_cpy =false;
500                         echo '<p class="seperator">&nbsp;</p>';
502                         echo "<div style='width:100%;text-align:right;'><form name='form' method='post' action='?plug=".$_GET['plug']."' target='_parent'>
503                                 <br><input type='submit' name='back' value='"._("Continue")."'>
504                                 </form></div>";
506                         echo "</body></html>";
508                         return (TRUE);
509                 }
510         }
512 // vim:tabstop=2:expandtab:shiftwidth=2:filetype=php:syntax:ruler:
513 ?>