1 <?php
2 /*
3 * This code is part of GOsa (http://www.gosa-project.org)
4 * Copyright (C) 2003-2008 GONICUS GmbH
5 *
6 * ID: $$Id$$
7 *
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21 */
23 class tabs
24 {
25 var $dn;
26 var $config;
27 var $acl;
28 var $is_template;
29 var $is_new= FALSE;
31 var $last= "";
32 var $current= "";
33 var $disabled= "";
34 var $by_name= array();
35 var $by_object= array();
36 var $SubDialog = false;
37 var $acl_category;
38 var $multiple_support_active = FALSE;
40 var $parent = null; // A parent object if available, e.g. a management class.
42 var $read_only = FALSE; // Used when the entry is opened as "readonly" due to locks.
43 var $hide_refs = FALSE;
44 var $hide_acls = FALSE;
46 function tabs(&$config, $data, $dn, $acl_category= "", $hide_refs = FALSE, $hide_acls = FALSE)
47 {
48 /* Save dn */
49 $this->dn= $dn;
50 $this->config= &$config;
51 $this->hide_refs = $hide_refs;
52 $this->hide_acls = $hide_acls;
54 if(!count($data)) {
55 $data[] = array("CLASS" => 'plugin',"NAME" => 'Error');
56 msg_dialog::display(_("Error"),
57 sprintf(_("No plugin definitions found to initialize '%s', please check your configuration file."),get_class($this)),
58 "ERROR_DIALOG");
59 }
61 $baseobject= NULL;
62 $this->acl_category = $acl_category;
63 foreach ($data as &$tab){
65 if (!plugin_available($tab['CLASS'])){
66 trigger_error(sprintf("Unknown class '%s'!", $tab['CLASS']));
67 continue;
68 }
69 if ($this->current == "") $this->current= $tab['CLASS'];
71 $this->by_name[$tab['CLASS']]= $tab['NAME'];
73 if ($baseobject === NULL){
74 $baseobject= new $tab['CLASS']($this->config, $this->dn);
75 $baseobject->enable_CSN_check();
76 $this->by_object[$tab['CLASS']]= $baseobject;
77 } else {
78 $this->by_object[$tab['CLASS']]= new $tab['CLASS']($this->config, $this->dn, $baseobject);
79 }
81 $this->read_only |= $this->by_object[$tab['CLASS']]->read_only;
82 $this->by_object[$tab['CLASS']]->parent= &$this;
83 $this->by_object[$tab['CLASS']]->set_acl_category($this->acl_category);
84 }
85 }
88 /*! \brief Reinitializes the tab classes with fresh ldap values.
89 This maybe usefull if for example the apply button was pressed.
90 */
91 function re_init()
92 {
93 $baseobject= NULL;
94 foreach($this->by_object as $name => $object){
95 $class = get_class($object);
96 if(in_array($class,array("reference","acl"))) continue;
97 if ($baseobject === NULL){
98 $baseobject= new $class($this->config, $this->dn);
99 $baseobject->enable_CSN_check();
100 $this->by_object[$name]= $baseobject;
101 } else {
102 $this->by_object[$name]= new $class($this->config, $this->dn, $baseobject);
103 }
104 $this->by_object[$name]->parent= &$this;
105 $this->by_object[$name]->set_acl_category($this->acl_category);
106 }
107 }
110 function execute()
111 {
112 // Ensure that the currently selected tab is valid.
113 if(!isset($this->by_name[$this->current])) {
114 $this->current = key($this->by_name);
115 }
117 pathNavigator::registerPlugin($this);
119 // Rotate current to last
120 $this->last= $this->current;
122 // Look for pressed tab button
123 foreach ($this->by_object as $class => &$obj){
124 if (isset($_POST[$class]) || (isset($_POST['arg']) && $_POST['arg'] == "$class")){
125 $this->current= $class;
126 break;
127 }
128 }
130 // Save last tab object
131 if ($this->last == $this->current){
132 $this->save_object(TRUE);
133 } else {
134 $this->save_object(FALSE);
135 }
137 /* If multiple edit is enabled for this tab,
138 we have tho display different templates */
139 if(!$this->multiple_support_active){
140 $display= $this->by_object[$this->current]->execute();
141 }else{
142 $display= $this->by_object[$this->current]->multiple_execute();
143 }
144 $tabs= $this->gen_tabs();
145 $display =
146 "\n {$tabs}".
147 "\n <input type='hidden' name='arg' value=''>".
148 "\n <div class='tab-content'>".
149 "\n {$display}".
150 "\n </div>";
152 return ($display);
153 }
155 function save_object($save_current= FALSE)
156 {
157 /* Save last tab */
158 if ($this->last != ""){
159 @DEBUG (DEBUG_TRACE, __LINE__, __FUNCTION__, __FILE__,
160 $this->last, "Saving");
162 if(!$this->multiple_support_active){
163 $this->by_object[$this->last]->save_object ();
164 }else{
165 $this->by_object[$this->last]->multiple_save_object();
166 }
167 }
169 /* Skip if curent and last are the same object */
170 if ($this->last == $this->current){
171 return;
172 }
174 $obj= @$this->by_object[$this->current];
175 $this->disabled= $obj->parent->disabled;
177 if ($save_current){
178 @DEBUG (DEBUG_TRACE, __LINE__, __FUNCTION__, __FILE__,
179 $this->current, "Saving (current)");
181 if(!$this->multiple_support_active){
182 $obj->save_object();
183 }else{
184 $obj->multiple_save_object();
185 }
186 }
187 }
190 function is_modal_dialog()
191 {
192 return($this->by_object[$this->current]->is_modal_dialog());
193 }
195 function gen_tabs()
196 {
197 if($this->is_modal_dialog()) return("");
199 $display = "\n <div class='tabs'>";
200 $display.= "\n <ul>";
202 foreach ($this->by_name as $class => $name){
204 // Shorten string if its too long for the tab headers
205 $title= _($name);
206 if (mb_strlen($title, 'UTF-8') > 28){
207 $title= mb_substr($title,0, 25, 'UTF-8')."...";
208 }
210 // nobr causes w3c warnings so we use to keep the tab name in one line
211 $title= str_replace(" "," ",$title);
213 // Take care about notifications
214 $obj = $this->by_object[$class];
215 $tabClass = ($this->current == $class) ? "current" :"";
216 if ( $this->by_object[$class]->pl_notify && ($obj->is_account || $obj->ignore_account)){
217 $tabClass .= " info";
218 }
219 if(!empty($tabClass)) $tabClass="class='{$tabClass}'";
220 $onClick = "document.mainform.arg.value='{$class}'; document.mainform.submit();";
221 $display.= "\n <li {$tabClass} onClick=\"{$onClick}\">{$title}</li>";
222 }
223 $display.="\n </ul>";
224 $display.="\n </div>";
225 return($display);
226 }
229 function set_acl($acl)
230 {
231 /* Look for attribute in ACL */
232 trigger_error("Don't use tabs::set_acl() its obsolete.");
233 }
235 function delete()
236 {
237 /* Check if all plugins will ACK for deletion */
238 foreach (array_reverse($this->by_object) as $key => $obj){
239 $reason= $obj->allow_remove();
240 if ($reason != ""){
241 msg_dialog::display(_("Warning"), sprintf(_("Delete process has been canceled by plugin '%s': %s"), $key, $reason), WARNING_DIALOG);
242 return;
243 }
244 }
246 /* Delete for all plugins */
247 foreach (array_reverse($this->by_object) as $obj){
248 $obj->remove_from_parent();
249 }
250 }
252 function password_change_needed()
253 {
254 /* Ask all plugins for needed password changes */
255 foreach ($this->by_object as &$obj){
256 if ($obj->password_change_needed()){
257 return TRUE;
258 }
259 }
261 return FALSE;
262 }
264 function check($ignore_account= FALSE)
265 {
266 $this->save_object(TRUE);
267 $messages= array();
269 $current_set = FALSE;
271 /* Check all plugins */
272 foreach ($this->by_object as $key => &$obj){
273 if ($obj->is_account || $ignore_account || $obj->ignore_account){
274 @DEBUG (DEBUG_TRACE, __LINE__, __FUNCTION__, __FILE__,$key, "Checking");
276 if(!$this->multiple_support_active){
277 $msg = $obj->check();
278 }else{
279 $msg = $obj->multiple_check();
280 }
282 if (count($msg)){
283 $obj->pl_notify= TRUE;
284 if(!$current_set){
285 $current_set = TRUE;
286 $this->current= $key;
287 $messages = $msg;
288 }
289 }else{
290 $obj->pl_notify= FALSE;
291 }
292 }else{
293 $obj->pl_notify= FALSE;
294 }
295 }
296 return ($messages);
297 }
299 function save($ignore_account= FALSE)
300 {
301 /* Save all plugins */
302 foreach ($this->by_object as $key => &$obj){
303 @DEBUG (DEBUG_TRACE, __LINE__, __FUNCTION__, __FILE__,
304 $key, "Saving");
306 $obj->dn= $this->dn;
308 if(!$obj instanceof plugin && !$obj instanceOf management){
309 trigger_error("Something went wrong while saving ".$obj->dn.". Object class '".get_class($obj)."'.");
310 }else{
312 if ($obj->is_account || $ignore_account || $obj->ignore_account){
313 if ($obj->save() == 1){
314 return (1);
315 }
316 } else {
317 $obj->remove_from_parent();
318 }
319 }
320 }
321 return (0);
322 }
324 function adapt_from_template($dn, $skip= array())
325 {
326 foreach ($this->by_object as $key => &$obj){
327 @DEBUG (DEBUG_TRACE, __LINE__, __FUNCTION__, __FILE__,
328 $key, "Adapting");
329 $obj->parent= &$this;
330 $obj->adapt_from_template($dn, $skip);
331 }
332 }
335 /* Save attributes posted by copy & paste dialog
336 */
337 function saveCopyDialog()
338 {
339 foreach ($this->by_object as &$obj){
340 if($obj->is_account || $obj->ignore_account){
341 $obj->saveCopyDialog();
342 }
343 }
344 }
347 /* return copy & paste dialog
348 */
349 function getCopyDialog()
350 {
351 $ret = "";
352 $this->SubDialog = false;
353 foreach ($this->by_object as &$obj){
354 if($obj->is_account || $obj->ignore_account){
355 $tmp = $obj->getCopyDialog();
356 if($tmp['status'] == "SubDialog"){
357 $this->SubDialog = true;
358 return($tmp['string']);
359 }else{
360 if(!empty($tmp['string'])){
361 $ret .= $tmp['string'];
362 $ret .= "<hr>";
363 }
364 }
365 }
366 }
367 return($ret);
368 }
371 function addSpecialTabs()
372 {
373 if(!$this->hide_acls){
374 $this->by_name['acl']= _("ACL");
375 $this->by_object['acl']= new acl($this->config, $this, $this->dn);
376 $this->by_object['acl']->parent= &$this;
377 }
378 if(!$this->hide_refs){
379 $this->by_name['reference']= _("References");
380 $this->by_object['reference']= new reference($this->config, $this->dn);
381 $this->by_object['reference']->parent= &$this;
382 }
383 }
386 function set_acl_base($base= "")
387 {
388 /* Update reference, transfer variables */
389 $first= ($base == "");
390 foreach ($this->by_object as &$obj){
391 if ($first){
392 $first= FALSE;
393 $base= $obj->acl_base;
394 } else {
395 $obj->set_acl_base($base);
396 }
397 }
398 }
401 /*! \brief Checks if one of the used tab plugins supports multiple edit.
402 @param boolean Returns TRUE if at least one plugins supports multiple edit.
403 */
404 function multiple_support_available()
405 {
406 foreach($this->by_object as $name => $obj){
407 if($obj->multiple_support){
408 return(TRUE);
409 }
410 }
411 return(FALSE);
412 }
415 /*! \brief Enables multiple edit support for the given tab.
416 All unsupported plugins will be disabled.
417 @param boolean Returns TRUE if at least one plugin supports multiple edit
418 */
419 function enable_multiple_support()
420 {
421 if(!$this->multiple_support_available()){
422 return(FALSE);
423 }else{
424 $this->multiple_support_active = TRUE;
425 foreach($this->by_object as $name => $obj){
426 if($obj->multiple_support){
427 $this->by_object[$name]->enable_multiple_support();
428 }else{
429 unset($this->by_object[$name]);
430 unset($this->by_name[$name]);
431 }
432 }
433 }
434 return(TRUE);
435 }
437 function setReadOnly($s = TRUE)
438 {
439 foreach($this->by_object as $name => $obj){
440 $this->by_object[$name]->read_only = $s;
441 }
442 }
443 }
444 // vim:tabstop=2:expandtab:shiftwidth=2:filetype=php:syntax:ruler:
445 ?>