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 // Rotate current to last
118 $this->last= $this->current;
120 // Look for pressed tab button
121 foreach ($this->by_object as $class => &$obj){
122 if (isset($_POST[$class]) || (isset($_POST['arg']) && $_POST['arg'] == "$class")){
123 $this->current= $class;
124 break;
125 }
126 }
128 // Save last tab object
129 if ($this->last == $this->current){
130 $this->save_object(TRUE);
131 } else {
132 $this->save_object(FALSE);
133 }
135 /* If multiple edit is enabled for this tab,
136 we have tho display different templates */
137 if(!$this->multiple_support_active){
138 $display= $this->by_object[$this->current]->execute();
139 }else{
140 $display= $this->by_object[$this->current]->multiple_execute();
141 }
142 $tabs= $this->gen_tabs();
143 $display =
144 "\n {$tabs}".
145 "\n <input type='hidden' name='arg' value=''>".
146 "\n <div class='tab-content'>".
147 "\n {$display}".
148 "\n </div>";
150 return ($display);
151 }
153 function save_object($save_current= FALSE)
154 {
155 /* Save last tab */
156 if ($this->last != ""){
157 @DEBUG (DEBUG_TRACE, __LINE__, __FUNCTION__, __FILE__,
158 $this->last, "Saving");
160 if(!$this->multiple_support_active){
161 $this->by_object[$this->last]->save_object ();
162 }else{
163 $this->by_object[$this->last]->multiple_save_object();
164 }
165 }
167 /* Skip if curent and last are the same object */
168 if ($this->last == $this->current){
169 return;
170 }
172 $obj= @$this->by_object[$this->current];
173 $this->disabled= $obj->parent->disabled;
175 if ($save_current){
176 @DEBUG (DEBUG_TRACE, __LINE__, __FUNCTION__, __FILE__,
177 $this->current, "Saving (current)");
179 if(!$this->multiple_support_active){
180 $obj->save_object();
181 }else{
182 $obj->multiple_save_object();
183 }
184 }
185 }
187 function gen_tabs()
188 {
189 if($this->by_object[$this->current]->is_modal_dialog()) return("");
191 $display = "\n <div class='tabs'>";
192 $display.= "\n <ul>";
194 foreach ($this->by_name as $class => $name){
196 // Shorten string if its too long for the tab headers
197 $title= _($name);
198 if (mb_strlen($title, 'UTF-8') > 28){
199 $title= mb_substr($title,0, 25, 'UTF-8')."...";
200 }
202 // nobr causes w3c warnings so we use to keep the tab name in one line
203 $title= str_replace(" "," ",$title);
205 // Take care about notifications
206 $obj = $this->by_object[$class];
207 $tabClass = ($this->current == $class) ? "current" :"";
208 if ( $this->by_object[$class]->pl_notify && ($obj->is_account || $obj->ignore_account)){
209 $tabClass .= " info";
210 }
211 if(!empty($tabClass)) $tabClass="class='{$tabClass}'";
212 $onClick = "document.mainform.arg.value='{$class}'; document.mainform.submit();";
213 $display.= "\n <li {$tabClass} onClick=\"{$onClick}\">{$title}</li>";
214 }
215 $display.="\n </ul>";
216 $display.="\n </div>";
217 return($display);
218 }
221 function set_acl($acl)
222 {
223 /* Look for attribute in ACL */
224 trigger_error("Don't use tabs::set_acl() its obsolete.");
225 }
227 function delete()
228 {
229 /* Check if all plugins will ACK for deletion */
230 foreach (array_reverse($this->by_object) as $key => $obj){
231 $reason= $obj->allow_remove();
232 if ($reason != ""){
233 msg_dialog::display(_("Warning"), sprintf(_("Delete process has been canceled by plugin '%s': %s"), $key, $reason), WARNING_DIALOG);
234 return;
235 }
236 }
238 /* Delete for all plugins */
239 foreach (array_reverse($this->by_object) as $obj){
240 $obj->remove_from_parent();
241 }
242 }
244 function password_change_needed()
245 {
246 /* Ask all plugins for needed password changes */
247 foreach ($this->by_object as &$obj){
248 if ($obj->password_change_needed()){
249 return TRUE;
250 }
251 }
253 return FALSE;
254 }
256 function check($ignore_account= FALSE)
257 {
258 $this->save_object(TRUE);
259 $messages= array();
261 $current_set = FALSE;
263 /* Check all plugins */
264 foreach ($this->by_object as $key => &$obj){
265 if ($obj->is_account || $ignore_account || $obj->ignore_account){
266 @DEBUG (DEBUG_TRACE, __LINE__, __FUNCTION__, __FILE__,$key, "Checking");
268 if(!$this->multiple_support_active){
269 $msg = $obj->check();
270 }else{
271 $msg = $obj->multiple_check();
272 }
274 if (count($msg)){
275 $obj->pl_notify= TRUE;
276 if(!$current_set){
277 $current_set = TRUE;
278 $this->current= $key;
279 $messages = $msg;
280 }
281 }else{
282 $obj->pl_notify= FALSE;
283 }
284 }else{
285 $obj->pl_notify= FALSE;
286 }
287 }
288 return ($messages);
289 }
291 function save($ignore_account= FALSE)
292 {
293 /* Save all plugins */
294 foreach ($this->by_object as $key => &$obj){
295 @DEBUG (DEBUG_TRACE, __LINE__, __FUNCTION__, __FILE__,
296 $key, "Saving");
298 $obj->dn= $this->dn;
300 if(!$obj instanceof plugin && !$obj instanceOf management){
301 trigger_error("Something went wrong while saving ".$obj->dn.". Object class '".get_class($obj)."'.");
302 }else{
304 if ($obj->is_account || $ignore_account || $obj->ignore_account){
305 if ($obj->save() == 1){
306 return (1);
307 }
308 } else {
309 $obj->remove_from_parent();
310 }
311 }
312 }
313 return (0);
314 }
316 function adapt_from_template($dn, $skip= array())
317 {
318 foreach ($this->by_object as $key => &$obj){
319 @DEBUG (DEBUG_TRACE, __LINE__, __FUNCTION__, __FILE__,
320 $key, "Adapting");
321 $obj->parent= &$this;
322 $obj->adapt_from_template($dn, $skip);
323 }
324 }
327 /* Save attributes posted by copy & paste dialog
328 */
329 function saveCopyDialog()
330 {
331 foreach ($this->by_object as &$obj){
332 if($obj->is_account || $obj->ignore_account){
333 $obj->saveCopyDialog();
334 }
335 }
336 }
339 /* return copy & paste dialog
340 */
341 function getCopyDialog()
342 {
343 $ret = "";
344 $this->SubDialog = false;
345 foreach ($this->by_object as &$obj){
346 if($obj->is_account || $obj->ignore_account){
347 $tmp = $obj->getCopyDialog();
348 if($tmp['status'] == "SubDialog"){
349 $this->SubDialog = true;
350 return($tmp['string']);
351 }else{
352 if(!empty($tmp['string'])){
353 $ret .= $tmp['string'];
354 $ret .= "<p class='seperator'> </p>";
355 }
356 }
357 }
358 }
359 return($ret);
360 }
363 function addSpecialTabs()
364 {
365 if(!$this->hide_acls){
366 $this->by_name['acl']= _("ACL");
367 $this->by_object['acl']= new acl($this->config, $this, $this->dn);
368 $this->by_object['acl']->parent= &$this;
369 }
370 if(!$this->hide_refs){
371 $this->by_name['reference']= _("References");
372 $this->by_object['reference']= new reference($this->config, $this->dn);
373 $this->by_object['reference']->parent= &$this;
374 }
375 }
378 function set_acl_base($base= "")
379 {
380 /* Update reference, transfer variables */
381 $first= ($base == "");
382 foreach ($this->by_object as &$obj){
383 if ($first){
384 $first= FALSE;
385 $base= $obj->acl_base;
386 } else {
387 $obj->set_acl_base($base);
388 }
389 }
390 }
393 /*! \brief Checks if one of the used tab plugins supports multiple edit.
394 @param boolean Returns TRUE if at least one plugins supports multiple edit.
395 */
396 function multiple_support_available()
397 {
398 foreach($this->by_object as $name => $obj){
399 if($obj->multiple_support){
400 return(TRUE);
401 }
402 }
403 return(FALSE);
404 }
407 /*! \brief Enables multiple edit support for the given tab.
408 All unsupported plugins will be disabled.
409 @param boolean Returns TRUE if at least one plugin supports multiple edit
410 */
411 function enable_multiple_support()
412 {
413 if(!$this->multiple_support_available()){
414 return(FALSE);
415 }else{
416 $this->multiple_support_active = TRUE;
417 foreach($this->by_object as $name => $obj){
418 if($obj->multiple_support){
419 $this->by_object[$name]->enable_multiple_support();
420 }else{
421 unset($this->by_object[$name]);
422 unset($this->by_name[$name]);
423 }
424 }
425 }
426 return(TRUE);
427 }
428 }
429 // vim:tabstop=2:expandtab:shiftwidth=2:filetype=php:syntax:ruler:
430 ?>