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 $ldap->ls ("(&(ou=".$this->ou.")(objectClass=organizationalUnit))", $this->base, array('dn'));
225 if ($this->orig_dn == "new" && $ldap->count()){
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 if(is_department_name_reserved($this->ou,$this->base)){
240 $message[]= sprintf(_("The field 'Name' contains the reserved word '%s'. Please choose another name."),$this->ou);
241 }
243 if (preg_match ('/[#+:=>\\\\\/]/', $this->ou)){
244 $message[]= _("The field 'Name' contains invalid characters.");
245 }
246 if (!is_phone_nr($this->telephoneNumber)){
247 $message[]= _("The field 'Phone' contains an invalid phone number.");
248 }
249 if (!is_phone_nr($this->facsimileTelephoneNumber)){
250 $message[]= _("The field 'Fax' contains an invalid phone number.");
251 }
253 return $message;
254 }
257 /* Save to LDAP */
258 function save()
259 {
260 $ldap= $this->config->get_ldap_link();
262 /* Add tag objects if needed */
263 if ($this->is_administrational_unit){
264 if(!in_array_ics("gosaAdministrativeUnit",$this->objectclasses)){
265 $this->objectclasses[]= "gosaAdministrativeUnit";
266 $this->gosaUnitTag= "";
267 }
269 if ($this->gosaUnitTag == ""){
271 /* It's unlikely, but check if already used... */
272 $try= 5;
273 $ldap->cd($this->config->current['BASE']);
274 while ($try--){
276 /* Generate microtime stamp as tag */
277 list($usec, $sec)= explode(" ", microtime());
278 $time_stamp= preg_replace("/\./", "", $sec.$usec);
280 $ldap->search("(&(objectClass=gosaAdministrativeUnit)(gosaUnitTag=$time_stamp))",array("gosaUnitTag"));
281 if ($ldap->count() == 0){
282 break;
283 }
284 }
285 if($try == 0) {
286 print_red(_("Fatal error: Can't find an unused tag to mark the administrative unit!"));
287 return;
288 }
289 $this->gosaUnitTag= preg_replace("/\./", "", $sec.$usec);
290 }
291 }
293 plugin::save();
295 /* Remove tag information if needed */
296 if (!$this->is_administrational_unit){
297 $tmp= array();
299 /* Remove gosaAdministrativeUnit from this plugin */
300 $has_unit_tag= false;
301 foreach($this->attrs['objectClass'] as $oc){
302 if (!preg_match("/^gosaAdministrativeUnit$/i", $oc)){
303 $tmp[]= $oc;
304 }
305 if (preg_match("/^gosaAdministrativeUnitTag$/i", $oc)){
306 $has_unit_tag= true;
307 }
308 }
309 $this->attrs['objectClass']= $tmp;
311 if(!$has_unit_tag && isset($this->attrs['gosaUnitTag'])){
312 $this->attrs['gosaUnitTag']= array();
313 }
314 }
316 /* Write back to ldap */
317 $ldap= $this->config->get_ldap_link();
318 $ldap->cat($this->dn, array('dn'));
319 $a= $ldap->fetch();
320 $ldap->cd($this->dn);
322 if (count($a)){
323 $this->cleanup();
324 $ldap->modify ($this->attrs);
326 $this->handle_post_events('modify');
327 } else {
328 $ldap->add($this->attrs);
329 $this->handle_post_events('add');
330 }
331 show_ldap_error($ldap->get_error(), _("Saving department failed"));
333 /* The parameter forces only to set must_be_tagged, and don't touch any objects
334 This will be done later */
335 $this->tag_objects(true);
337 /* Fix tagging if needed */
338 if (!$this->is_administrational_unit){
339 $this->handle_object_tagging();
340 }
342 /* Optionally execute a command after we're done */
343 $this->postcreate();
344 return(true);
345 }
348 function ShowMoveFrame()
349 {
350 $smarty = get_smarty();
351 $smarty->assign("src","?plug=".$_GET['plug']."&PerformRecMove");
352 $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.");
353 $display= $smarty->fetch(get_template_path("dep_iframe.tpl",TRUE));
354 return($display);
355 }
357 function ShowTagFrame()
358 {
359 $smarty = get_smarty();
360 $smarty->assign("src","?plug=".$_GET['plug']."&TagDepartment");
361 $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.");
362 $display= $smarty->fetch(get_template_path("dep_iframe.tpl",TRUE));
363 return($display);
364 }
366 /* Tag objects to have the gosaAdministrativeUnitTag */
367 function tag_objects($OnlySetTagFlag = false)
368 {
369 if(!$OnlySetTagFlag){
370 $smarty= get_smarty();
371 echo "<!-- headers.tpl-->".$smarty->fetch(get_template_path('headers.tpl'));
372 echo "<body style='background-image:none;margin:3px;color:black'>";
373 echo "<h3>".sprintf(_("Tagging '%s'."),"<i>".@LDAP::fix($this->dn)."</i>")."</h3>";
374 }
376 $add= $this->is_administrational_unit;
377 $len= strlen($this->dn);
378 $ldap= $this->config->get_ldap_link();
379 $ldap->cd($this->dn);
380 if ($add){
381 $ldap->search('(!(&(objectClass=gosaAdministrativeUnitTag)(gosaUnitTag='.
382 $this->gosaUnitTag.')))', array('dn'));
383 } else {
384 $ldap->search('objectClass=gosaAdministrativeUnitTag', array('dn'));
385 }
387 while ($attrs= $ldap->fetch()){
389 /* Skip self */
390 if ($attrs['dn'] == $this->dn){
391 continue;
392 }
394 /* Check for confilicting administrative units */
395 $fix= true;
396 foreach ($this->config->adepartments as $key => $tag){
397 /* This one is shorter than our dn, its not relevant... */
398 if ($len >= strlen($key)){
399 continue;
400 }
402 /* This one matches with the latter part. Break and don't fix this entry */
403 if (preg_match('/(^|,)'.normalizePreg($key).'$/', $attrs['dn'])){
404 $fix= false;
405 break;
406 }
407 }
409 /* Fix entry if needed */
410 if ($fix){
411 if($OnlySetTagFlag){
412 $this->must_be_tagged =true;
413 return;
414 }
415 $this->handle_object_tagging($attrs['dn'], $this->gosaUnitTag, TRUE );
416 }
417 }
418 if(!$OnlySetTagFlag){
419 echo '<p class="seperator"> </p>';
420 echo "<div style='width:100%;text-align:right;'><form name='form' method='post' action='?plug=".$_GET['plug']."' target='_parent'>
421 <br><input type='submit' name='back' value='"._("Continue")."'>
422 </form></div>";
423 }
424 }
427 /* Move/Rename complete trees */
428 function recursive_move($src_dn, $dst_dn,$force = false)
429 {
430 /* If force == false prepare to recursive move this object from src to dst
431 on the next call. */
432 if(!$force){
433 $this->rec_cpy = true;
434 $this->rec_src = $src_dn;
435 $this->rec_dst = $dst_dn;
436 }else{
438 /* If this is called, but not wanted, abort */
439 if(!$this->rec_cpy){
440 return;
441 }
443 $src_dn = $this->rec_src;
444 $dst_dn = $this->rec_dst;
446 /* Print header to have styles included */
447 $smarty= get_smarty();
448 echo "<!-- headers.tpl-->".$smarty->fetch(get_template_path('headers.tpl'));
449 echo "<body style='background-image:none;margin:3px;color:black'>";
451 echo "<h3>".sprintf(_("Moving '%s' to '%s'"),"<i>".@LDAP::fix($src_dn)."</i>","<i>".@LDAP::fix($dst_dn)."</i>")."</h3>";
454 /* Check if the destination entry exists */
455 $ldap= $this->config->get_ldap_link();
457 /* Check if destination exists - abort */
458 $ldap->cat($dst_dn, array('dn'));
459 if ($ldap->fetch()){
460 trigger_error("Recursive_move ".@LDAP::fix($dst_dn)." already exists.",
461 E_USER_WARNING);
462 echo sprintf("Recursive_move: '%s' already exists", @LDAP::fix($dst_dn))."<br>";
463 return (FALSE);
464 }
466 /* Perform a search for all objects to be moved */
467 $objects= array();
468 $ldap->cd($src_dn);
469 $ldap->search("(objectClass=*)", array("dn"));
470 while($attrs= $ldap->fetch()){
471 $dn= $attrs['dn'];
472 $objects[$dn]= strlen($dn);
473 }
475 /* Sort objects by indent level */
476 asort($objects);
477 reset($objects);
479 /* Copy objects from small to big indent levels by replacing src_dn by dst_dn */
480 foreach ($objects as $object => $len){
483 $src= str_replace("\\","\\\\",$object);
484 $dst= preg_replace("/".str_replace("\\","\\\\",$src_dn)."$/", "$dst_dn", $object);
485 $dst= str_replace($src_dn,$dst_dn,$object);
487 echo "<b>"._("Object").":</b> ".@LDAP::fix($src)."<br>";
489 if (!$this->copy($src, $dst)){
490 echo "<font color='#FF0000'><br>".sprintf(_("FAILED to copy %s, aborting operation"),@LDAP::fix($src))."</font>";
491 return (FALSE);
492 }
494 flush();
495 }
497 /* Remove src_dn */
498 $ldap->cd($src_dn);
499 $ldap->recursive_remove();
500 $this->rec_src = $this->rec_dst = "";
501 $this->rec_cpy =false;
503 echo '<p class="seperator"> </p>';
505 echo "<div style='width:100%;text-align:right;'><form name='form' method='post' action='?plug=".$_GET['plug']."' target='_parent'>
506 <br><input type='submit' name='back' value='"._("Continue")."'>
507 </form></div>";
509 echo "</body></html>";
511 return (TRUE);
512 }
513 }
514 }
515 // vim:tabstop=2:expandtab:shiftwidth=2:filetype=php:syntax:ruler:
516 ?>