source: trunk/phpgwapi/inc/class.common.inc.php @ 368

Revision 368, 59.3 KB checked in by niltonneto, 16 years ago (diff)

Código para atenuar eventuais problemas de conexão com LDAP,
tentando reconectar em seguida.

  • Property svn:eol-style set to native
  • Property svn:executable set to *
Line 
1<?php
2  /**************************************************************************\
3  * eGroupWare API - Commononly used functions                               *
4  * This file written by Dan Kuykendall <seek3r@phpgroupware.org>            *
5  * and Joseph Engo <jengo@phpgroupware.org>                                 *
6  * and Mark Peters <skeeter@phpgroupware.org>                               *
7  * and Lars Kneschke <lkneschke@linux-at-work.de>                           *
8  * Functions commonly used by eGroupWare developers                         *
9  * Copyright (C) 2000, 2001 Dan Kuykendall                                  *
10  * Copyright (C) 2003 Lars Kneschke                                         *
11  * -------------------------------------------------------------------------*
12  * This library is part of the eGroupWare API                               *
13  * http://www.egroupware.org                                                *
14  * ------------------------------------------------------------------------ *
15  * This library is free software; you can redistribute it and/or modify it  *
16  * under the terms of the GNU Lesser General Public License as published by *
17  * the Free Software Foundation; either version 2.1 of the License,         *
18  * or any later version.                                                    *
19  * This library is distributed in the hope that it will be useful, but      *
20  * WITHOUT ANY WARRANTY; without even the implied warranty of               *
21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.                     *
22  * See the GNU Lesser General Public License for more details.              *
23  * You should have received a copy of the GNU Lesser General Public License *
24  * along with this library; if not, write to the Free Software Foundation,  *
25  * Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA            *
26  \**************************************************************************/
27
28        function ldap_rebind($ldap_connection, $ldap_url)
29        {
30                @ldap_bind($ldap_connection, $GLOBALS['phpgw_info']['server']['user_ldap_referral'], $GLOBALS['phpgw_info']['server']['password_ldap_referral']);
31        }
32        $d1 = strtolower(@substr(PHPGW_API_INC,0,3));
33        $d2 = strtolower(@substr(PHPGW_SERVER_ROOT,0,3));
34        $d3 = strtolower(@substr(PHPGW_APP_INC,0,3));
35        if($d1 == 'htt' || $d1 == 'ftp' || $d2 == 'htt' || $d2 == 'ftp' || $d3 == 'htt' || $d3 == 'ftp')
36        {
37                echo 'Failed attempt to break in via an old Security Hole!<br>'."\n";
38                exit;
39        }
40        unset($d1);unset($d2);unset($d3);
41
42        /*!
43        @class common
44        @abstract common class that contains commonly used functions
45        */
46        class common
47        {
48                var $debug_info; // An array with debugging info from the API
49                var $found_files;
50
51                /*!
52                @function cmp_version
53                @abstract Compares two Version strings and return 1 if str2 is newest (bigger version number) than str1
54                @discussion This function checks for major version only.
55                @param $str1
56                @param $str2
57                */
58                function cmp_version($str1,$str2,$debug=False)
59                {
60                        ereg("([0-9]+)\.([0-9]+)\.([0-9]+)[a-zA-Z]*([0-9]*)",$str1,$regs);
61                        ereg("([0-9]+)\.([0-9]+)\.([0-9]+)[a-zA-Z]*([0-9]*)",$str2,$regs2);
62                        if($debug) { echo "<br>$regs[0] - $regs2[0]"; }
63
64                        for($i=1;$i<5;$i++)
65                        {
66                                if($debug) { echo "<br>$i: $regs[$i] - $regs2[$i]"; }
67                                if($regs2[$i] == $regs[$i])
68                                {
69                                        continue;
70                                }
71                                if($regs2[$i] > $regs[$i])
72                                {
73                                        return 1;
74                                }
75                                elseif($regs2[$i] < $regs[$i])
76                                {
77                                        return 0;
78                                }
79                        }
80                }
81
82                /*!
83                @function cmp_version_long
84                @abstract Compares two Version strings and return 1 if str2 is newest (bigger version number) than str1
85                @discussion This function checks all fields. cmp_version() checks release version only.
86                @param $str1
87                @param $str2
88                */
89                function cmp_version_long($str1,$str2,$debug=False)
90                {
91                        ereg("([0-9]+)\.([0-9]+)\.([0-9]+)[a-zA-Z]*([0-9]*)\.([0-9]*)",$str1,$regs);
92                        ereg("([0-9]+)\.([0-9]+)\.([0-9]+)[a-zA-Z]*([0-9]*)\.([0-9]*)",$str2,$regs2);
93                        if($debug) { echo "<br>$regs[0] - $regs2[0]"; }
94
95                        for($i=1;$i<6;$i++)
96                        {
97                                if($debug) { echo "<br>$i: $regs[$i] - $regs2[$i]"; }
98
99                                if($regs2[$i] == $regs[$i])
100                                {
101                                        if($debug) { echo ' are equal...'; }
102                                        continue;
103                                }
104                                if($regs2[$i] > $regs[$i])
105                                {
106                                        if($debug) { echo ', and a > b'; }
107                                        return 1;
108                                }
109                                elseif($regs2[$i] < $regs[$i])
110                                {
111                                        if($debug) { echo ', and a < b'; }
112                                        return 0;
113                                }
114                        }
115                        if($debug) { echo ' - all equal.'; }
116                }
117
118                // Convert an array into the format needed for the access column.
119                /*!
120                @function array_to_string
121                @abstract Convert an array into the format needed for the access column
122                @param $access
123                @param $array
124                */
125                function array_to_string($access,$array)
126                {
127                        $this->debug_info[] = 'array_to_string() is a depreciated function - use ACL instead';
128                        $s = '';
129                        if ($access == 'group' || $access == 'public' || $access == 'none')
130                        {
131                                if (count($array))
132                                {
133                                        while ($t = each($array))
134                                        {
135                                                $s .= ',' . $t[1];
136                                        }
137                                        $s .= ',';
138                                }
139                                if (! count($array) && $access == 'none')
140                                {
141                                        $s = '';
142                                }
143                        }
144                        return $s;
145                }
146
147                // This is used for searching the access fields
148                /*!
149                @function sql_search
150                @abstract this function is used for searching the access fields
151                @param $table
152                @param $owner
153                */
154                function sql_search($table,$owner=0)
155                {
156                        $this->debug_info[] = 'sql_search() is a deprecated function - use ACL instead';
157                        $s = '';
158                        if (!$owner)
159                        {
160                                $owner = $GLOBALS['phpgw_info']['user']['account_id'];
161                        }
162                        $groups = $GLOBALS['phpgw']->accounts->membership((int)$owner);
163                        if(@is_array($groups))
164                        {
165                                while ($group = each($groups))
166                                {
167                                        $s .= " OR $table LIKE '%," . $group[2] . ",%'";
168                                }
169                        }
170                        return $s;
171                }
172
173                // return a array of installed languages
174                /*!
175                @function getInstalledLanguages
176                @abstract return an array of installed languages
177                @result $installedLanguages; an array containing the installed languages
178                */
179                function getInstalledLanguages()
180                {
181                        $GLOBALS['phpgw']->db->query('SELECT DISTINCT lang FROM phpgw_lang');
182                        while (@$GLOBALS['phpgw']->db->next_record())
183                        {
184                                $installedLanguages[$GLOBALS['phpgw']->db->f('lang')] = $GLOBALS['phpgw']->db->f('lang');
185                        }
186
187                        return $installedLanguages;
188                }
189
190                // return the preferred language of the users
191                // it's using HTTP_ACCEPT_LANGUAGE (send from the users browser)
192                // and ...(to find out which languages are installed)
193                /*!
194                @function getPreferredLanguage
195                @abstract return the preferred langugae of the users
196                @discussion it uses HTTP_ACCEPT_LANGUAGE (from the users browser) <br>
197                and .... to find out which languages are installed
198                */
199                function getPreferredLanguage()
200                {
201                        // create a array of languages the user is accepting
202                        $userLanguages = explode(',',$_SERVER['HTTP_ACCEPT_LANGUAGE']);
203                        $supportedLanguages = $this->getInstalledLanguages();
204
205                        // find usersupported language
206//                      while (list($key,$value) = each($userLanguages))
207                        foreach($userLanguages as $key => $value)
208                        {
209                                // remove everything behind '-' example: de-de
210                                $value = trim($value);
211                                $pieces = explode('-', $value);
212                                $value = $pieces[0];
213                                # print 'current lang $value<br>';
214                                if ($supportedLanguages[$value])
215                                {
216                                        $retValue=$value;
217                                        break;
218                                }
219                        }
220
221                        // no usersupported language found -> return english
222                        if (empty($retValue))
223                        {
224                                $retValue='en';
225                        }
226
227                        return $retValue;
228                }
229
230                /*!
231                @function ldap_addslashes
232                @abstract escapes a string for use in searchfilters meant for ldap_search.
233                Escaped Characters are: '*', '(', ')', ' ', '\', NUL
234                It's actually a PHP-Bug, that we have to escape space.
235                For all other Characters, refer to RFC2254.
236                @param $string string to be escaped
237                */
238                function ldap_addslashes($string='')
239                {
240                        return str_replace(array('\\','*','(',')','\0',' '),array('\\\\','\*','\(','\)','\\0','\20'),$string);
241                }
242
243                // connect to the ldap server and return a handle
244                /*!
245                @function ldapConnect
246                @abstract connect to the ldap server and return a handle
247                @param $host ldap host
248                @param $dn ldap_root_dn
249                @param $passwd ldap_root_pw
250                */
251                function ldapConnect($host='', $dn='', $passwd='', $ldapreferral=false) #default: dont follow the referral
252                {
253                       
254                        if(!$host || $host == $GLOBALS['phpgw_info']['server']['ldap_host']) {                       
255                                $dn     = $dn ? $dn : $GLOBALS['phpgw_info']['server']['ldap_root_dn'];
256                                $passwd = $passwd ? $passwd : $GLOBALS['phpgw_info']['server']['ldap_root_pw'];
257                                $host   = $host ? $host : $GLOBALS['phpgw_info']['server']['ldap_host'];
258                        }
259
260                        /*else if(strstr($host, "ldap://")){
261                                $dn = '';
262                                $passwd = '';
263                        }*/
264
265                        if(!function_exists('ldap_connect'))
266                        {
267                                /* log does not exist in setup(, yet) */
268                                if(is_object($GLOBALS['phpgw']->log))
269                                {
270                                        $GLOBALS['phpgw']->log->message('F-Abort, LDAP support unavailable');
271                                        $GLOBALS['phpgw']->log->commit();
272                                }
273
274                                printf('<b>Error: LDAP support unavailable</b><br>',$host);
275                                return False;
276                        }
277
278                        // connect to ldap server
279                        if(!$ds = ldap_connect($host))
280                        {
281                                /* log does not exist in setup(, yet) */
282                                if(is_object($GLOBALS['phpgw']->log))
283                                {
284                                        $GLOBALS['phpgw']->log->message('F-Abort, Failed connecting to LDAP server');
285                                        $GLOBALS['phpgw']->log->commit();
286                                }
287
288                                printf("<b>Error: Can't connect to LDAP server %s!</b><br>",$host);
289                                return False;
290                        }
291
292                        if($GLOBALS['phpgw_info']['server']['ldap_version3'])
293                        {
294                                if(!ldap_set_option($ds,LDAP_OPT_PROTOCOL_VERSION,3))
295                                {
296                                        $GLOBALS['phpgw_info']['server']['ldap_version3'] = False;
297                                }
298                        }
299                       
300                        ldap_set_option($ds, LDAP_OPT_REFERRALS, $ldapreferral);
301                        if($ldapreferral){
302                                $GLOBALS['phpgw_info']['server']['user_ldap_referral'] = $dn;
303                                $GLOBALS['phpgw_info']['server']['password_ldap_referral'] = $passwd;
304                                ldap_set_rebind_proc($ds, ldap_rebind);
305                        }
306                        // bind as admin
307                        if($dn && $passwd && !@ldap_bind($ds,$dn,$passwd))
308                        {                               
309                                // Try rebind for connection problem
310                                if(!@ldap_bind($ds,$dn,$passwd)) {
311                                        if(is_object($GLOBALS['phpgw']->log))
312                                        {
313                                                $GLOBALS['phpgw']->log->message('F-Abort, Failed binding to LDAP server');
314                                                $GLOBALS['phpgw']->log->commit();
315                                        }
316
317                                        echo '<center><b>'.lang("ExpressoLivre is unavailable at this moment. Code %1<br>Please, try later.","002").'</b></center>';
318                                        return False;
319                                }
320                        }
321                        // bind as anonymous
322                        if(!$dn && !$passwd && !@ldap_bind($ds))
323                        {
324                                if(is_object($GLOBALS['phpgw']->log))
325                                {
326                                        $GLOBALS['phpgw']->log->message('F-Abort, Failed  (anonymous bind) to LDAP server');
327                                        $GLOBALS['phpgw']->log->commit();
328                                }
329                                echo '<center><b>'.lang("ExpressoLivre is unavailable at this moment. Code %1<br>Please, try later.","002").'</b></center>';
330                                //printf("<b>Error: Can't bind to LDAP server (anonymous bind): %s!</b><br>",$dn);
331                                return False;
332                        }                                               
333                        return $ds;
334                }
335
336                // This function is used if the developer wants to stop a running app in the middle of execution
337                // We may need to do some clean up before hand
338                /*!
339                @function phpgw_exit
340                @abstract function to stop running an app
341                @discussion used to stop running an app in the middle of execution <br>
342                There may need to be some cleanup before hand
343                @param $call_footer boolean value to if true then call footer else exit
344                */
345                function phpgw_exit($call_footer = False)
346                {
347                        if (!defined('PHPGW_EXIT'))
348                        {
349                                define('PHPGW_EXIT',True);
350
351                                if ($call_footer)
352                                {
353                                        $this->phpgw_footer();
354                                }
355                        }
356                        exit;
357                }
358
359                function phpgw_final()
360                {
361                        if (!defined('PHPGW_FINAL'))
362                        {
363                                define('PHPGW_FINAL',True);
364
365                                /*if (is_object($GLOBALS['phpgw']->accounts))
366                                {
367                                        $GLOBALS['phpgw']->accounts->save_session_cache();
368                                }*/
369                                // call the asyncservice check_run function if it is not explicitly set to cron-only
370                                //
371                                if (!$GLOBALS['phpgw_info']['server']['asyncservice'])  // is default
372                                {
373                                        ExecMethod('phpgwapi.asyncservice.check_run','fallback');
374                                }
375                                /* Clean up mcrypt */
376                                if (@is_object($GLOBALS['phpgw']->crypto))
377                                {
378                                        $GLOBALS['phpgw']->crypto->cleanup();
379                                        unset($GLOBALS['phpgw']->crypto);
380                                }
381                                $GLOBALS['phpgw']->db->disconnect();
382                        }
383                }
384
385                /*!
386                @function randomstring
387                @abstract return a random string of size $size
388                @param $size int-size of random string to return
389                */
390                function randomstring($size)
391                {
392                        $s = '';
393                        srand((double)microtime()*1000000);
394                        $random_char = array(
395                                '0','1','2','3','4','5','6','7','8','9','a','b','c','d','e','f',
396                                'g','h','i','j','k','l','m','n','o','p','q','r','s','t','u','v',
397                                'w','x','y','z','A','B','C','D','E','F','G','H','I','J','K','L',
398                                'M','N','O','P','Q','R','S','T','U','V','W','X','Y','Z'
399                        );
400
401                        for ($i=0; $i<$size; $i++)
402                        {
403                                $s .= $random_char[rand(1,61)];
404                        }
405                        return $s;
406                }
407
408                // Look at the note towards the top of this file (jengo)
409                function filesystem_separator()
410                {
411                        return filesystem_separator();
412                }
413
414                /*!
415                @function error_list
416                @abstract This is used for reporting errors in a nice format.
417                @param $error - array of errors
418                */
419                function error_list($errors,$text='Error')
420                {
421                        if (! is_array($errors))
422                        {
423                                return False;
424                        }
425
426                        $html_error = '<table border="0" width="100%"><tr><td align="right"><b>' . lang($text)
427                                . '</b>: </td><td align="left">' . $errors[0] . '</td></tr>';
428                        for ($i=1; $i<count($errors); $i++)
429                        {
430                                $html_error .= '<tr><td>&nbsp;</td><td align="left">' . $errors[$i] . '</td></tr>';
431                        }
432                        return $html_error . '</table>';
433                }
434
435                /*!
436                @function check_owner
437                @abstract none yet
438                @param $record ?
439                @param $link ?
440                @param $label ?
441                @param $extravars
442                */
443                // This is a depreciated function - use ACL instead (jengo)
444                function check_owner($record,$link,$label,$extravars = '')
445                {
446                        $this->debug_info[] = 'check_owner() is a depreciated function - use ACL instead';
447                        /*
448                        $s = '<a href="' . $GLOBALS['phpgw']->link($link,$extravars) . '"> ' . lang($label) . ' </a>';
449                        if (ereg('^[0-9]+$',$record))
450                        {
451                                if ($record != $GLOBALS['phpgw_info']['user']['account_id'])
452                                {
453                                        $s = '&nbsp;';
454                                }
455                        }
456                        else
457                        {
458                                if ($record != $GLOBALS['phpgw_info']['user']['userid'])
459                                {
460                                        $s = '&nbsp';
461                                }
462                        }
463
464                        return $s;
465                        */
466                }
467
468                /*!
469                @function display_fullname
470                @abstract return the fullname of a user
471                @param $lid account loginid
472                @param $firstname firstname
473                @param $lastname lastname
474                */
475                function display_fullname($lid = '', $firstname = '', $lastname = '')
476                {
477                        if (! $lid && ! $firstname && ! $lastname)
478                        {
479                                $lid       = $GLOBALS['phpgw_info']['user']['account_lid'];
480                                $firstname = $GLOBALS['phpgw_info']['user']['firstname'];
481                                $lastname  = $GLOBALS['phpgw_info']['user']['lastname'];
482                        }
483
484                        $display = $GLOBALS['phpgw_info']['user']['preferences']['common']['account_display'];
485
486                        if ($firstname && $lastname)
487                        {
488                                $delimiter = ', ';
489                        }
490                        else
491                        {
492                                $delimiter = '';
493                        }
494                       
495                        $name = '';
496                        switch($display)
497                        {
498                                case 'firstname':
499                                        $name = $firstname . ' ' . $lastname;
500                                        break;
501                                case 'lastname':
502                                        $name = $lastname . $delimiter . $firstname;
503                                        break;
504                                case 'username':
505                                        $name = $lid;
506                                        break;
507                                case 'firstall':
508                                        $name = $firstname . ' ' . $lastname . ' ['.$lid.']';
509                                        break;
510                                case 'lastall':
511                                        $name = $lastname . $delimiter . $firstname . ' ['.$lid.']';
512                                        break;
513                                case 'all':
514                                        /* fall through */
515                                default:
516                                        $name = '['.$lid.'] ' . $firstname . ' ' . $lastname;
517                        }
518                        return $name;
519                }
520
521                /*!
522                @function grab_owner_name
523                @abstract grab the owner name
524                @param $id account id
525                */
526                function grab_owner_name($accountid = '')
527                {
528                        $GLOBALS['phpgw']->accounts->get_account_name($accountid,$lid,$fname,$lname);
529                        return $this->display_fullname($lid,$fname,$lname);
530                }
531
532                /*!
533                @function create_tabs
534                @abstract create tabs
535                @param $tabs ?
536                @param $selected ?
537                @param $fontsize optional
538                */
539                function create_tabs($tabs, $selected, $fontsize = '')
540                {
541                        $output_text = '<table border="0" cellspacing="0" cellpadding="0"><tr>';
542
543                        /* This is a php3 workaround */
544                        if(PHPGW_IMAGES_DIR == 'PHPGW_IMAGES_DIR')
545                        {
546                                $ir = ExecMethod('phpgwapi.phpgw.common.get_image_path', 'phpgwapi');
547                        }
548                        else
549                        {
550                                $ir = PHPGW_IMAGES_DIR;
551                        }
552
553                        if ($fontsize)
554                        {
555                                $fs  = '<font size="' . $fontsize . '">';
556                                $fse = '</font>';
557                        }
558
559                        $i = 1;
560                        while ($tab = each($tabs))
561                        {
562                                if ($tab[0] == $selected)
563                                {
564                                        if ($i == 1)
565                                        {
566                                                $output_text .= '<td align="right"><img src="' . $ir . '/tabs-start1.gif"></td>';
567                                        }
568
569                                        $output_text .= '<td align="left" background="' . $ir . '/tabs-bg1.gif">&nbsp;<b><a href="'
570                                                . $tab[1]['link'] . '" class="tablink" '.$tab[1]['target'].'>' . $fs . $tab[1]['label']
571                                                . $fse . '</a></b>&nbsp;</td>';
572                                        if ($i == count($tabs))
573                                        {
574                                                $output_text .= '<td align="left"><img src="' . $ir . '/tabs-end1.gif"></td>';
575                                        }
576                                        else
577                                        {
578                                                $output_text .= '<td align="left"><img src="' . $ir . '/tabs-sepr.gif"></td>';
579                                        }
580                                }
581                                else
582                                {
583                                        if ($i == 1)
584                                        {
585                                                $output_text .= '<td align="right"><img src="' . $ir . '/tabs-start0.gif"></td>';
586                                        }
587                                        $output_text .= '<td align="left" background="' . $ir . '/tabs-bg0.gif">&nbsp;<b><a href="'
588                                                . $tab[1]['link'] . '" class="tablink" '.$tab[1]['target'].'>' . $fs . $tab[1]['label'] . $fse
589                                                . '</a></b>&nbsp;</td>';
590                                        if (($i + 1) == $selected)
591                                        {
592                                                $output_text .= '<td align="left"><img src="' . $ir . '/tabs-sepl.gif"></td>';
593                                        }
594                                        elseif ($i == $selected || $i != count($tabs))
595                                        {
596                                                $output_text .= '<td align="left"><img src="' . $ir . '/tabs-sepm.gif"></td>';
597                                        }
598                                        elseif ($i == count($tabs))
599                                        {
600                                                if ($i == $selected)
601                                                {
602                                                        $output_text .= '<td align="left"><img src="' . $ir . '/tabs-end1.gif"></td>';
603                                                }
604                                                else
605                                                {
606                                                        $output_text .= '<td align="left"><img src="' . $ir . '/tabs-end0.gif"></td>';
607                                                }
608                                        }
609                                        else
610                                        {
611                                                if ($i != count($tabs))
612                                                {
613                                                        $output_text .= '<td align="left"><img src="' . $ir . '/tabs-sepr.gif"></td>';
614                                                }
615                                        }
616                                }
617                                $i++;
618                                $output_text .= "\n";
619                        }
620                        $output_text .= "</table>\n";
621                        return $output_text;
622                }
623
624                /*!
625                @function get_app_dir
626                @abstract get directory of application
627                @discussion $appname can either be passed or derived from $phpgw_info['flags']['currentapp'];
628                @param $appname name of application
629                */
630                function get_app_dir($appname = '')
631                {
632                        if ($appname == '')
633                        {
634                                $appname = $GLOBALS['phpgw_info']['flags']['currentapp'];
635                        }
636                        if ($appname == 'home' || $appname == 'logout' || $appname == 'login')
637                        {
638                                $appname = 'phpgwapi';
639                        }
640
641                        $appdir         = PHPGW_INCLUDE_ROOT . '/'.$appname;
642                        $appdir_default = PHPGW_SERVER_ROOT . '/'.$appname;
643
644                        if (@is_dir ($appdir))
645                        {
646                                return $appdir;
647                        }
648                        elseif (@is_dir ($appdir_default))
649                        {
650                                return $appdir_default;
651                        }
652                        else
653                        {
654                                return False;
655                        }
656                }
657
658                /*!
659                @function get_inc_dir
660                @abstract get inc (include dir) of application
661                @discussion $appname can either be passed or derived from $phpgw_info['flags']['currentapp'];
662                @param $appname name of application
663                */
664                function get_inc_dir($appname = '')
665                {
666                        if (! $appname)
667                        {
668                                $appname = $GLOBALS['phpgw_info']['flags']['currentapp'];
669                        }
670                        if ($appname == 'home' || $appname == 'logout' || $appname == 'login' || $appname == 'about')
671                        {
672                                $appname = 'phpgwapi';
673                        }
674
675                        $incdir         = PHPGW_INCLUDE_ROOT . '/' . $appname . '/inc';
676                        $incdir_default = PHPGW_SERVER_ROOT . '/' . $appname . '/inc';
677
678                        if (@is_dir ($incdir))
679                        {
680                                return $incdir;
681                        }
682                        elseif (@is_dir ($incdir_default))
683                        {
684                                return $incdir_default;
685                        }
686                        else
687                        {
688                                return False;
689                        }
690                }
691
692                /*!
693                @function list_themes
694                @abstract list themes available
695                @note themes can either be css file like in HEAD (if the template has a css-dir and has css-files in is) \
696                        or ordinary .14 themes-files
697                */
698                function list_themes()
699                {
700                        $tpl_dir = $this->get_tpl_dir('phpgwapi');
701
702                        if ($dh = @opendir($tpl_dir . SEP . 'css'))
703                        {
704                                while ($file = readdir($dh))
705                                {
706                                        if (eregi("\.css$", $file) && $file != 'phpgw.css')
707                                        {
708                                                $list[] = substr($file,0,strpos($file,'.'));
709                                        }
710                                }
711                        }
712                        if(!is_array($list))
713                        {
714                                $dh = opendir(PHPGW_SERVER_ROOT . '/phpgwapi/themes');
715                                while ($file = readdir($dh))
716                                {
717                                        if (eregi("\.theme$", $file))
718                                        {
719                                                $list[] = substr($file,0,strpos($file,'.'));
720                                        }
721                                }
722                        }
723                        closedir($dh);
724                        reset ($list);
725                        return $list;
726                }
727
728                /**
729                * List available templates
730                *
731                * @returns array alphabetically sorted list of templates
732                */
733                function list_templates()
734                {
735                        $d = dir(PHPGW_SERVER_ROOT . '/phpgwapi/templates');
736                        while ($entry=$d->read())
737                        {
738                                if ($entry != 'CVS' && $entry != '.' && $entry != '..'
739                                        && $entry != 'phpgw_website'
740                                        && is_dir(PHPGW_SERVER_ROOT . '/phpgwapi/templates/' . $entry))
741                                {
742                                        $list[$entry]['name'] = $entry;
743                                        $f = PHPGW_SERVER_ROOT . '/phpgwapi/templates/' . $entry . '/details.inc.php';
744                                        if (file_exists ($f))
745                                        {
746                                                include($f);
747                                                $list[$entry]['title'] = 'Use '.$GLOBALS['phpgw_info']['template'][$entry]['title'].'interface';
748                                        }
749                                        else
750                                        {
751                                                $list[$entry]['title'] = $entry;
752                                        }
753                                }
754                        }
755                        $d->close();
756                        ksort($list);
757                        return $list;
758                }
759
760                /*!
761                @function get_tpl_dir
762                @abstract get template dir of an application
763                @param $appname appication name optional can be derived from $phpgw_info['flags']['currentapp'];
764                */
765                function get_tpl_dir($appname = '')
766                {
767                        if (! $appname)
768                        {
769                                $appname = $GLOBALS['phpgw_info']['flags']['currentapp'];
770                        }
771                        if ($appname == 'home' || $appname == 'logout' || $appname == 'login')
772                        {
773                                $appname = 'phpgwapi';
774                        }
775
776                        if (!isset($GLOBALS['phpgw_info']['server']['template_set']) && isset($GLOBALS['phpgw_info']['user']['preferences']['common']['template_set']))
777                        {
778                                $GLOBALS['phpgw_info']['server']['template_set'] = $GLOBALS['phpgw_info']['user']['preferences']['common']['template_set'];
779                        }
780
781                        // Setting this for display of template choices in user preferences
782                        if ($GLOBALS['phpgw_info']['server']['template_set'] == 'user_choice')
783                        {
784                                $GLOBALS['phpgw_info']['server']['usrtplchoice'] = 'user_choice';
785                        }
786
787                        if (($GLOBALS['phpgw_info']['server']['template_set'] == 'user_choice' ||
788                                !isset($GLOBALS['phpgw_info']['server']['template_set'])) &&
789                                isset($GLOBALS['phpgw_info']['user']['preferences']['common']['template_set']))
790                        {
791                                $GLOBALS['phpgw_info']['server']['template_set'] = $GLOBALS['phpgw_info']['user']['preferences']['common']['template_set'];
792                        }
793                        elseif ($GLOBALS['phpgw_info']['server']['template_set'] == 'user_choice' ||
794                                !isset($GLOBALS['phpgw_info']['server']['template_set']))
795                        {
796                                $GLOBALS['phpgw_info']['server']['template_set'] = 'default';
797                        }
798
799                        $tpldir         = PHPGW_SERVER_ROOT . '/' . $appname . '/templates/' . $GLOBALS['phpgw_info']['server']['template_set'];
800                        $tpldir_default = PHPGW_SERVER_ROOT . '/' . $appname . '/templates/default';
801
802                        if (@is_dir($tpldir))
803                        {
804                                return $tpldir;
805                        }
806                        elseif (@is_dir($tpldir_default))
807                        {
808                                return $tpldir_default;
809                        }
810                        else
811                        {
812                                return False;
813                        }
814                }
815
816                /*!
817                @function is_image_dir
818                @abstract checks if image_dir exists and has more than just a navbar-icon
819                @note this is just a workaround for idots, better to use find_image, which has a fallback \
820                        on a per image basis to the default dir
821                */
822                function is_image_dir($dir)
823                {
824                        if (!@is_dir($dir))
825                        {
826                                return False;
827                        }
828                        if ($d = opendir($dir))
829                        {
830                                while ($f = readdir($d))
831                                {
832                                        $ext = strtolower(strrchr($f,'.'));
833                                        if (($ext == '.gif' || $ext == '.png') && strstr($f,'navbar') === False)
834                                        {
835                                                return True;
836                                        }
837                                }
838                        }
839                        return False;
840                }
841
842                /*!
843                @function get_image_dir
844                @abstract get image dir of an application
845                @param $appname application name optional can be derived from $phpgw_info['flags']['currentapp'];
846                */
847                function get_image_dir($appname = '')
848                {
849                        if ($appname == '')
850                        {
851                                $appname = $GLOBALS['phpgw_info']['flags']['currentapp'];
852                        }
853                        if (empty($GLOBALS['phpgw_info']['server']['template_set']))
854                        {
855                                $GLOBALS['phpgw_info']['server']['template_set'] = 'default';
856                        }
857
858                        $imagedir            = PHPGW_SERVER_ROOT . '/' . $appname . '/templates/'
859                                . $GLOBALS['phpgw_info']['server']['template_set'] . '/images';
860                        $imagedir_default    = PHPGW_SERVER_ROOT . '/' . $appname . '/templates/default/images';
861                        $imagedir_olddefault = PHPGW_SERVER_ROOT . '/' . $appname . '/images';
862
863                        if ($this->is_image_dir ($imagedir))
864                        {
865                                return $imagedir;
866                        }
867                        elseif ($this->is_image_dir ($imagedir_default))
868                        {
869                                return $imagedir_default;
870                        }
871                        elseif ($this->is_image_dir ($imagedir_olddefault))
872                        {
873                                return $imagedir_olddefault;
874                        }
875                        else
876                        {
877                                return False;
878                        }
879                }
880
881                /*!
882                @function get_image_path
883                @abstract get image path of an application
884                @param $appname appication name optional can be derived from $phpgw_info['flags']['currentapp'];
885                */
886                function get_image_path($appname = '')
887                {
888                        if ($appname == '')
889                        {
890                                $appname = $GLOBALS['phpgw_info']['flags']['currentapp'];
891                        }
892
893                        if (empty($GLOBALS['phpgw_info']['server']['template_set']))
894                        {
895                                $GLOBALS['phpgw_info']['server']['template_set'] = 'default';
896                        }
897
898                        $imagedir            = PHPGW_SERVER_ROOT . '/'.$appname.'/templates/'.$GLOBALS['phpgw_info']['server']['template_set'].'/images';
899                        $imagedir_default    = PHPGW_SERVER_ROOT . '/'.$appname.'/templates/default/images';
900                        $imagedir_olddefault = PHPGW_SERVER_ROOT . '/'.$appname.'/images';
901
902                        if ($this->is_image_dir ($imagedir))
903                        {
904                                return $GLOBALS['phpgw_info']['server']['webserver_url'].'/'.$appname.'/templates/'.$GLOBALS['phpgw_info']['server']['template_set'].'/images';
905                        }
906                        elseif ($this->is_image_dir ($imagedir_default))
907                        {
908                                return $GLOBALS['phpgw_info']['server']['webserver_url'].'/'.$appname.'/templates/default/images';
909                        }
910                        elseif ($this->is_image_dir ($imagedir_olddefault))
911                        {
912                                return $GLOBALS['phpgw_info']['server']['webserver_url'].'/'.$appname.'/images';
913                        }
914                        else
915                        {
916                                return False;
917                        }
918                }
919
920                function find_image($appname,$image)
921                {
922                        $imagedir = '/'.$appname.'/templates/'.$GLOBALS['phpgw_info']['user']['preferences']['common']['template_set'].'/images';
923                       
924                        if (!@is_array($this->found_files[$appname]))
925                        {
926                                $imagedir_olddefault = '/'.$appname.'/images';
927                                $imagedir_default    = '/'.$appname.'/templates/default/images';
928                               
929                                if (@is_dir(PHPGW_INCLUDE_ROOT.$imagedir_olddefault))
930                                {
931                                        $d = dir(PHPGW_INCLUDE_ROOT.$imagedir_olddefault);
932                                        while (false != ($entry = $d->read()))
933                                        {
934                                                if ($entry != '.' && $entry != '..')
935                                                {
936                                                        $this->found_files[$appname][$entry] = $imagedir_olddefault;
937                                                }
938                                        }
939                                        $d->close();
940                                }
941
942                                if (@is_dir(PHPGW_INCLUDE_ROOT.$imagedir_default))
943                                {
944                                        $d = dir(PHPGW_INCLUDE_ROOT.$imagedir_default);
945                                        while (false != ($entry = $d->read()))
946                                        {
947                                                if ($entry != '.' && $entry != '..')
948                                                {
949                                                        $this->found_files[$appname][$entry] = $imagedir_default;
950                                                }
951                                        }
952                                        $d->close();
953                                }
954
955                                if (@is_dir(PHPGW_INCLUDE_ROOT.$imagedir))
956                                {
957                                        $d = dir(PHPGW_INCLUDE_ROOT.$imagedir);
958                                        while (false != ($entry = $d->read()))
959                                        {
960                                                if ($entry != '.' && $entry != '..')
961                                                {
962                                                        $this->found_files[$appname][$entry] = $imagedir;
963                                                }
964                                        }
965                                        $d->close();
966                                }
967                        }
968                       
969                        if (!$GLOBALS['phpgw_info']['server']['image_type'])
970                        {
971                                // priority: GIF->JPG->PNG
972                                $img_type=array('.gif','.jpg','.png');
973                        }
974                        else
975                        {
976                                // priority: : PNG->JPG->GIF
977                                $img_type=array('.png','.jpg','.gif');
978                        }
979
980                        // first look in the selected template dir
981                        if(@$this->found_files[$appname][$image.$img_type[0]]==$imagedir)
982                        {
983                                $imgfile = $GLOBALS['phpgw_info']['server']['webserver_url'].$this->found_files[$appname][$image.$img_type[0]].'/'.$image.$img_type[0];
984                        }
985                        elseif(@$this->found_files[$appname][$image.$img_type[1]]==$imagedir)
986                        {
987                                $imgfile = $GLOBALS['phpgw_info']['server']['webserver_url'].$this->found_files[$appname][$image.$img_type[1]].'/'.$image.$img_type[1];
988                        }
989                        elseif(@$this->found_files[$appname][$image.$img_type[2]]==$imagedir)
990                        {
991                                $imgfile = $GLOBALS['phpgw_info']['server']['webserver_url'].$this->found_files[$appname][$image.$img_type[2]].'/'.$image.$img_type[2];
992                        }
993                        // then look everywhere else
994                        elseif(isset($this->found_files[$appname][$image.$img_type[0]]))
995                        {
996                                $imgfile = $GLOBALS['phpgw_info']['server']['webserver_url'].$this->found_files[$appname][$image.$img_type[0]].'/'.$image.$img_type[0];
997                        }
998                        elseif(isset($this->found_files[$appname][$image.$img_type[1]]))
999                        {
1000                                $imgfile = $GLOBALS['phpgw_info']['server']['webserver_url'].$this->found_files[$appname][$image.$img_type[1]].'/'.$image.$img_type[1];
1001                        }
1002                        elseif(isset($this->found_files[$appname][$image.$img_type[2]]))
1003                        {
1004                                $imgfile = $GLOBALS['phpgw_info']['server']['webserver_url'].$this->found_files[$appname][$image.$img_type[2]].'/'.$image.$img_type[2];
1005                        }
1006                        elseif(isset($this->found_files[$appname][$image]))
1007                        {
1008                                $imgfile = $GLOBALS['phpgw_info']['server']['webserver_url'].$this->found_files[$appname][$image].'/'.$image;
1009                        }
1010                        else
1011                        {
1012                                // searching the image in the api-dirs
1013                                if (!isset($this->found_files['phpgwapi']))
1014                                {
1015                                        $this->find_image('phpgwapi','');
1016                                }
1017
1018                                if(isset($this->found_files['phpgwapi'][$image.$img_type[0]]))
1019                                {
1020                                        $imgfile = $GLOBALS['phpgw_info']['server']['webserver_url'].$this->found_files['phpgwapi'][$image.$img_type[0]].'/'.$image.$img_type[0];
1021                                }
1022                                elseif(isset($this->found_files['phpgwapi'][$image.$img_type[1]]))
1023                                {
1024                                        $imgfile = $GLOBALS['phpgw_info']['server']['webserver_url'].$this->found_files['phpgwapi'][$image.$img_type[1]].'/'.$image.$img_type[1];
1025                                }
1026                                elseif(isset($this->found_files['phpgwapi'][$image.$img_type[2]]))
1027                                {
1028                                        $imgfile = $GLOBALS['phpgw_info']['server']['webserver_url'].$this->found_files['phpgwapi'][$image.$img_type[2]].'/'.$image.$img_type[2];
1029                                }
1030                                elseif(isset($this->found_files['phpgwapi'][$image]))
1031                                {
1032                                        $imgfile = $GLOBALS['phpgw_info']['server']['webserver_url'].$this->found_files['phpgwapi'][$image].'/'.$image;
1033                                }
1034                                else
1035                                {
1036                                        $imgfile = '';
1037                                }
1038                        }
1039                        return $imgfile;
1040                }
1041
1042                function image($appname,$image='',$ext='',$use_lang=True)
1043                {
1044                        if (!is_array($image))
1045                        {
1046                                if (empty($image))
1047                                {
1048                                        return '';
1049                                }
1050                                $image = array($image);
1051                        }
1052                        if ($use_lang)
1053                        {
1054                                while (list(,$img) = each($image))
1055                                {
1056                                        $lang_images[] = $img . '_' . $GLOBALS['phpgw_info']['user']['preferences']['common']['lang'];
1057                                        $lang_images[] = $img;
1058                                }
1059                                $image = $lang_images;
1060                        }
1061                        while (empty($image_found) && list(,$img) = each($image))
1062                        {
1063                                if(isset($this->found_files[$appname][$img.$ext]))
1064                                {
1065                                        $image_found = $GLOBALS['phpgw_info']['server']['webserver_url'].$this->found_files[$appname][$img.$ext].'/'.$img.$ext;
1066                                }
1067                                else
1068                                {
1069                                        $image_found = $this->find_image($appname,$img.$ext);
1070                                }
1071                        }
1072                        return $image_found;
1073                }
1074
1075                function image_on($appname,$image,$extension='_on')
1076                {
1077                        $with_extension = $this->image($appname,$image,$extension);
1078                        $without_extension = $this->image($appname,$image);
1079                        if($with_extension != '')
1080                        {
1081                                return $with_extension;
1082                        }
1083                        elseif($without_extension != '')
1084                        {
1085                                return $without_extension;
1086                        }
1087                        else
1088                        {
1089                                return '';
1090                        }
1091                }
1092
1093                /*!
1094                @function navbar
1095                @abstract none yet
1096                @discussion *someone wanna add some detail here*
1097                */
1098                function navbar()
1099                {
1100                        $GLOBALS['phpgw_info']['navbar']['home']['title'] = 'Home';
1101                        $GLOBALS['phpgw_info']['navbar']['home']['url']   = $GLOBALS['phpgw']->link('/home.php');
1102                        $GLOBALS['phpgw_info']['navbar']['home']['icon']  = $this->image('phpgwapi',Array('home','nonav'));
1103                        $GLOBALS['phpgw_info']['navbar']['home']['icon_hover']  = $this->image_on('phpgwapi',Array('home','nonav'),'-over');
1104
1105                        list($first) = each($GLOBALS['phpgw_info']['user']['apps']);
1106                        if(is_array($GLOBALS['phpgw_info']['user']['apps']['admin']) && $first != 'admin')
1107                        {
1108                                $newarray['admin'] = $GLOBALS['phpgw_info']['user']['apps']['admin'];
1109                                foreach($GLOBALS['phpgw_info']['user']['apps'] as $index => $value)
1110                                {
1111                                        if($index != 'admin')
1112                                        {
1113                                                $newarray[$index] = $value;
1114                                        }
1115                                }
1116                                $GLOBALS['phpgw_info']['user']['apps'] = $newarray;
1117                                reset($GLOBALS['phpgw_info']['user']['apps']);
1118                        }
1119                        unset($index);
1120                        unset($value);
1121                        unset($newarray);
1122
1123                        foreach($GLOBALS['phpgw_info']['user']['apps'] as $app => $data)
1124                        {
1125                                if (is_long($app))
1126                                {
1127                                        continue;
1128                                }
1129
1130                                if ($app == 'preferences' || $GLOBALS['phpgw_info']['apps'][$app]['status'] != 2 && $GLOBALS['phpgw_info']['apps'][$app]['status'] != 3)
1131                                {
1132                                        $GLOBALS['phpgw_info']['navbar'][$app]['title'] = $GLOBALS['phpgw_info']['apps'][$app]['title'];
1133                                        $GLOBALS['phpgw_info']['navbar'][$app]['url']   = $GLOBALS['phpgw']->link('/' . $app . '/index.php',$GLOBALS['phpgw_info']['flags']['params'][$app]);
1134                                        $GLOBALS['phpgw_info']['navbar'][$app]['name']  = $app;
1135
1136                                        // create popup target
1137                                        if ($data['status'] == 4)
1138                                        {
1139                                                $GLOBALS['phpgw_info']['navbar'][$app]['target'] = ' target="'.$app.'" onClick="'."if (this != '') { window.open(this+'".
1140                                                        (strstr($GLOBALS['phpgw_info']['navbar'][$app]['url'],'?') ||
1141                                                        ini_get('session.use_trans_sid') && $GLOBALS['phpgw_info']['server']['sessions_type'] == 'php4' ?'&':'?').
1142                                                        "referer='+encodeURI(location),this.target,'width=800,height=600,scrollbars=yes,resizable=yes'); return false; } else { return true; }".'"';
1143                                        }
1144
1145                                        if ($app != $GLOBALS['phpgw_info']['flags']['currentapp'])
1146                                        {
1147                                                $GLOBALS['phpgw_info']['navbar'][$app]['icon']  = $this->image($app,Array('navbar','nonav'));
1148                                                $GLOBALS['phpgw_info']['navbar'][$app]['icon_hover']  = $this->image_on($app,Array('navbar','nonav'),'-over');
1149                                        }
1150                                        else
1151                                        {
1152                                                $GLOBALS['phpgw_info']['navbar'][$app]['icon']  = $this->image_on($app,Array('navbar','nonav'),'-over');
1153                                                $GLOBALS['phpgw_info']['navbar'][$app]['icon_hover']  = $this->image($app,Array('navbar','nonav'));
1154                                        }
1155
1156//                                      if($GLOBALS['phpgw_info']['navbar'][$app]['icon'] == '')
1157//                                      {
1158//                                              $GLOBALS['phpgw_info']['navbar'][$app]['icon']  = $this->image('phpgwapi','nonav');
1159//                                      }
1160                                }
1161                        }
1162                        if ($GLOBALS['phpgw_info']['flags']['currentapp'] == 'home' || $GLOBALS['phpgw_info']['flags']['currentapp'] == 'preferences' || $GLOBALS['phpgw_info']['flags']['currentapp'] == 'about')
1163                        {
1164                                $app = $app_title = 'eGroupWare';
1165                        }
1166                        else
1167                        {
1168                                $app = $GLOBALS['phpgw_info']['flags']['currentapp'];
1169                                $app_title = $GLOBALS['phpgw_info']['apps'][$app]['title'];
1170                        }
1171
1172                        if ($GLOBALS['phpgw_info']['user']['apps']['preferences'])      // preferences last
1173                        {
1174                                $prefs = $GLOBALS['phpgw_info']['navbar']['preferences'];
1175                                unset($GLOBALS['phpgw_info']['navbar']['preferences']);
1176                                $GLOBALS['phpgw_info']['navbar']['preferences'] = $prefs;
1177                        }
1178
1179                        // We handle this here becuase its special
1180                        $GLOBALS['phpgw_info']['navbar']['about']['title'] = lang('About %1',$app_title);
1181
1182                        $GLOBALS['phpgw_info']['navbar']['about']['url']   = $GLOBALS['phpgw']->link('/about.php','app='.$app);
1183                        $GLOBALS['phpgw_info']['navbar']['about']['icon']  = $this->image('phpgwapi',Array('about','nonav'));
1184                        $GLOBALS['phpgw_info']['navbar']['about']['icon_hover']  = $this->image_on('phpgwapi',Array('about','nonav'),'-over');
1185
1186                        $GLOBALS['phpgw_info']['navbar']['logout']['title'] = lang('Logout');
1187                        $GLOBALS['phpgw_info']['navbar']['logout']['url']   = $GLOBALS['phpgw']->link('/logout.php');
1188                        $GLOBALS['phpgw_info']['navbar']['logout']['icon']  = $this->image('phpgwapi',Array('logout','nonav'));
1189                        $GLOBALS['phpgw_info']['navbar']['logout']['icon_hover']  = $this->image_on('phpgwapi',Array('logout','nonav'),'-over');
1190                }
1191
1192                /*!
1193                @function app_header
1194                @abstract load header.inc.php for an application
1195                */
1196                function app_header()
1197                {
1198                        if (file_exists(PHPGW_APP_INC . '/header.inc.php'))
1199                        {
1200                                include(PHPGW_APP_INC . '/header.inc.php');
1201                        }
1202                }
1203                /*!
1204                @function phpgw_header
1205                @abstract load the phpgw header
1206                */
1207                function phpgw_header()
1208                {
1209                        // add a content-type header to overwrite an existing default charset in apache (AddDefaultCharset directiv)
1210                        header('Content-type: text/html; charset='.$GLOBALS['phpgw']->translation->charset());
1211                        include(PHPGW_INCLUDE_ROOT . '/phpgwapi/templates/' . $GLOBALS['phpgw_info']['server']['template_set']
1212                                . '/head.inc.php');
1213                        $this->navbar(False);
1214                        include(PHPGW_INCLUDE_ROOT . '/phpgwapi/templates/' . $GLOBALS['phpgw_info']['server']['template_set']
1215                                . '/navbar.inc.php');
1216                        if (!@$GLOBALS['phpgw_info']['flags']['nonavbar'] && !@$GLOBALS['phpgw_info']['flags']['navbar_target'])
1217                        {
1218                                echo parse_navbar();
1219                        }
1220                }
1221
1222                function phpgw_footer()
1223                {
1224                        if (!defined('PHPGW_FOOTER'))
1225                        {
1226                                define('PHPGW_FOOTER',True);
1227                                if (!isset($GLOBALS['phpgw_info']['flags']['nofooter']) || !$GLOBALS['phpgw_info']['flags']['nofooter'])
1228                                {
1229                                        include(PHPGW_API_INC . '/footer.inc.php');
1230                                }
1231                        }
1232                }
1233
1234                /**
1235                * Used by template headers for including CSS in the header
1236                *
1237                * This first loads up the basic global CSS definitions, which support
1238                * the selected user theme colors.  Next we load up the app CSS.  This is
1239                * all merged into the selected theme's css.tpl file.
1240                *
1241                * @author Dave Hall (*based* on verdilak? css inclusion code)
1242                */
1243                function get_css()
1244                {
1245                        $tpl = createObject('phpgwapi.Template', $this->get_tpl_dir('phpgwapi'));
1246                        $tpl->set_file('css', 'css.tpl');
1247                        $tpl->set_var($GLOBALS['phpgw_info']['theme']);
1248                        $app_css = '';
1249                        if(@isset($_GET['menuaction']))
1250                        {
1251                                list($app,$class,$method) = explode('.',$_GET['menuaction']);
1252                                if(is_array($GLOBALS[$class]->public_functions) &&
1253                                        $GLOBALS[$class]->public_functions['css'])
1254                                {
1255                                        $app_css .= $GLOBALS[$class]->css();
1256                                }
1257                        }
1258                        if (isset($GLOBALS['phpgw_info']['flags']['css']))
1259                        {
1260                                $app_css .= $GLOBALS['phpgw_info']['flags']['css'];
1261                        }
1262                        $tpl->set_var('app_css', $app_css);
1263
1264                        // search for app specific css file
1265                        if(@isset($GLOBALS['phpgw_info']['flags']['currentapp']))
1266                        {
1267                                $appname = $GLOBALS['phpgw_info']['flags']['currentapp'];
1268
1269                                if(file_exists(PHPGW_SERVER_ROOT . SEP . $appname . SEP
1270                                        . 'templates' . SEP . $GLOBALS['phpgw_info']['server']['template_set']
1271                                        . SEP . 'app.css')
1272                                )
1273                                {
1274                                        $tpl->set_var('css_file', '<LINK href="'.$GLOBALS['phpgw_info']['server']['webserver_url']
1275                                                . "/$appname/templates/".$GLOBALS['phpgw_info']['server']['template_set']
1276                                                . "/app.css".'" type=text/css rel=StyleSheet>');
1277                                }
1278                                elseif(file_exists(PHPGW_SERVER_ROOT . SEP . $appname . SEP
1279                                        . 'templates' . SEP . 'default'
1280                                        . SEP . 'app.css')
1281                                )
1282                                {
1283                                        $tpl->set_var('css_file', '<LINK href="'.$GLOBALS['phpgw_info']['server']['webserver_url']
1284                                        ."/$appname/templates/default/app.css".'" type=text/css rel=StyleSheet>');
1285                                }
1286                        }
1287
1288                        return $tpl->subst('css');
1289                }
1290
1291                /**
1292                * Used by the template headers for including javascript in the header
1293                *
1294                * The method is included here to make it easier to change the js support
1295                * in phpgw.  One change then all templates will support it (as long as they
1296                * include a call to this method).
1297                *
1298                * @author Dave Hall (*vaguely based* on verdilak? css inclusion code)
1299                * @return string the javascript to be included
1300                */
1301                function get_java_script()
1302                {
1303                        $java_script = '';
1304
1305                        /* this flag is for all javascript code that has to be put before other jscode.
1306                        Think of conf vars etc...  (pim@lingewoud.nl) */
1307                        if (isset($GLOBALS['phpgw_info']['flags']['java_script_thirst']))
1308                        {
1309                                $java_script .= $GLOBALS['phpgw_info']['flags']['java_script_thirst'] . "\n";
1310                        }
1311                       
1312                        if(@is_object($GLOBALS['phpgw']->js))
1313                        {
1314                                $java_script .= $GLOBALS['phpgw']->js->get_script_links();
1315                        }
1316
1317                        if(@isset($_GET['menuaction']))
1318                        {
1319                                list($app,$class,$method) = explode('.',$_GET['menuaction']);
1320                                if(is_array($GLOBALS[$class]->public_functions) &&
1321                                        $GLOBALS[$class]->public_functions['java_script'])
1322                                {
1323                                        $java_script .= $GLOBALS[$class]->java_script();
1324                                }
1325                        }
1326                        if (isset($GLOBALS['phpgw_info']['flags']['java_script']))
1327                        {
1328                                $java_script .= $GLOBALS['phpgw_info']['flags']['java_script'] . "\n";
1329                        }
1330                        return $java_script;
1331                }
1332
1333                /**
1334                * Returns on(Un)Load attributes from js class
1335                *
1336                *@author Dave Hall - skwashd at phpgroupware.org
1337                *@returns string body attributes
1338                */
1339                function get_body_attribs()
1340                {
1341                        if(@is_object($GLOBALS['phpgw']->js))
1342                        {
1343                                return $GLOBALS['phpgw']->js->get_body_attribs();
1344                        }
1345                        else
1346                        {
1347                                return '';
1348                        }
1349                }
1350
1351                function hex2bin($data)
1352                {
1353                        $len = strlen($data);
1354                        return @pack('H' . $len, $data);
1355                }
1356
1357                /*!
1358                @function encrypt
1359                @abstract encrypt data passed to the function
1360                @param $data data (string?) to be encrypted
1361                */
1362                function encrypt($data)
1363                {
1364                        return $GLOBALS['phpgw']->crypto->encrypt($data);
1365                }
1366
1367                /*!
1368                @function decrypt
1369                @abstract decrypt $data
1370                @param $data data to be decrypted
1371                */
1372                function decrypt($data)
1373                {
1374                        return $GLOBALS['phpgw']->crypto->decrypt($data);
1375                }
1376
1377                /*!
1378                @function encrypt_password
1379                @abstract legacy wrapper for newer auth class function, encrypt_password
1380                @abstract uses the encryption type set in setup and calls the appropriate encryption functions
1381                @param $password password to encrypt
1382                */
1383                function encrypt_password($password,$sql=False)
1384                {
1385                        if(!@is_object($GLOBALS['phpgw']->auth))
1386                        {
1387                                $GLOBALS['phpgw']->auth = CreateObject('phpgwapi.auth');
1388                        }
1389                        return $GLOBALS['phpgw']->auth->encrypt_password($password,$sql);
1390                }
1391
1392                /*!
1393                @function find_portal_order
1394                @abstract find the current position of the app is the users portal_order preference
1395                @param $app application id to find current position - required
1396                @discussion No discussion
1397                */
1398                function find_portal_order($app)
1399                {
1400                        if(!is_array($GLOBALS['phpgw_info']['user']['preferences']['portal_order']))
1401                        {
1402                                return -1;
1403                        }
1404                        @reset($GLOBALS['phpgw_info']['user']['preferences']['portal_order']);
1405                        while(list($seq,$appid) = each($GLOBALS['phpgw_info']['user']['preferences']['portal_order']))
1406                        {
1407                                if($appid == $app)
1408                                {
1409                                        @reset($GLOBALS['phpgw_info']['user']['preferences']['portal_order']);
1410                                        return $seq;
1411                                }
1412                        }
1413                        @reset($GLOBALS['phpgw_info']['user']['preferences']['portal_order']);
1414                        return -1;
1415                }
1416
1417                /*!
1418                @function hook
1419                @abstract temp wrapper to new hooks class
1420                */
1421                function hook($location, $appname = '', $no_permission_check = False)
1422                {
1423                        echo '$'."GLOBALS['phpgw']common->hook()".' has been replaced. Please change to the new $'."GLOBALS['phpgw']hooks->process()".'. For now this will act as a wrapper<br>';
1424                        return $GLOBALS['phpgw']->hooks->process($location, $order, $no_permission_check);
1425                }
1426
1427                /*!
1428                @function hook_single
1429                @abstract temp wrapper to new hooks class
1430                */
1431                // Note: $no_permission_check should *ONLY* be used when it *HAS* to be. (jengo)
1432                function hook_single($location, $appname = '', $no_permission_check = False)
1433                {
1434                        echo '$'."GLOBALS['phpgw']common->hook_single()".' has been replaced. Please change to the new $'."GLOBALS['phpgw']hooks->single()".'. For now this will act as a wrapper<br>';
1435                        return $GLOBALS['phpgw']->hooks->single($location, $order, $no_permission_check);
1436                }
1437
1438                /*!
1439                @function hook_count
1440                @abstract temp wrapper to new hooks class
1441                */
1442                function hook_count($location)
1443                {
1444                        echo '$'."GLOBALS['phpgw']common->hook_count()".' has been replaced. Please change to the new $'."GLOBALS['phpgw']hooks->count()".'. For now this will act as a wrapper<br>';
1445                        return $GLOBALS['phpgw']->hooks->count($location);
1446                }
1447
1448                /* Wrapper to the session->appsession() */
1449                function appsession($data = '##NOTHING##')
1450                {
1451                        $this->debug_info[] = '$phpgw->common->appsession() is a depreciated function'
1452                                . ' - use $phpgw->session->appsession() instead';
1453
1454                        return $GLOBALS['phpgw']->session->appsession('default','',$data);
1455                }
1456
1457                /*!
1458                @function show_date
1459                @abstract show current date
1460                @param $t time - optional can be pulled from user preferences
1461                @param $format - optional can be pulled from user prefernces
1462                */
1463                function show_date($t = '', $format = '')
1464                {
1465                        if(!is_object($GLOBALS['phpgw']->datetime))
1466                        {
1467                                $GLOBALS['phpgw']->datetime = createobject('phpgwapi.date_time');
1468                        }
1469
1470                        if (!$t || (int)$t <= 0)
1471                        {
1472                                $t = $GLOBALS['phpgw']->datetime->gmtnow;
1473                        }
1474                        //  + (date('I') == 1?3600:0)
1475                        $t += $GLOBALS['phpgw']->datetime->tz_offset;
1476                       
1477                        if (! $format)
1478                        {
1479                                $format = $GLOBALS['phpgw_info']['user']['preferences']['common']['dateformat'] . ' - ';
1480                                if ($GLOBALS['phpgw_info']['user']['preferences']['common']['timeformat'] == '12')
1481                                {
1482                                        $format .= 'h:i a';
1483                                }
1484                                else
1485                                {
1486                                        $format .= 'H:i';
1487                                }
1488                        }
1489                       
1490                        if((PHP_OS == 'Windows' || PHP_OS == 'WINNT') && (int)$t < 21600)
1491                        /*if(PHP_OS == 'Windows' && (int)$t < 21600)*/
1492                        {
1493                                $t = 21600;
1494                        }
1495                        return date($format,$t);
1496                }
1497
1498                /*!
1499                @function dateformatorder
1500                @abstract
1501                @param $yearstr year - string
1502                @param $monthstr month - string
1503                @param $day day - string
1504                @param $add_seperator boolean defaults to false
1505                */
1506                function dateformatorder($yearstr,$monthstr,$daystr,$add_seperator = False)
1507                {
1508                        $dateformat = strtolower($GLOBALS['phpgw_info']['user']['preferences']['common']['dateformat']);
1509                        $sep = substr($GLOBALS['phpgw_info']['user']['preferences']['common']['dateformat'],1,1);
1510
1511                        $dlarr[strpos($dateformat,'y')] = $yearstr;
1512                        $dlarr[strpos($dateformat,'m')] = $monthstr;
1513                        $dlarr[strpos($dateformat,'d')] = $daystr;
1514                        ksort($dlarr);
1515
1516                        if ($add_seperator)
1517                        {
1518                                return (implode($sep,$dlarr));
1519                        }
1520                        else
1521                        {
1522                                return (implode(' ',$dlarr));
1523                        }
1524                }
1525
1526                /*!
1527                @function formattime
1528                @abstract format the time takes settings from user preferences
1529                @param $hour hour
1530                @param $min minutes
1531                @param $sec defaults to ''
1532                */
1533                function formattime($hour,$min,$sec='')
1534                {
1535                        $h12 = $hour;
1536                        if ($GLOBALS['phpgw_info']['user']['preferences']['common']['timeformat'] == '12')
1537                        {
1538                                if ($hour >= 12)
1539                                {
1540                                        $ampm = ' pm';
1541                                }
1542                                else
1543                                {
1544                                        $ampm = ' am';
1545                                }
1546
1547                                $h12 %= 12;
1548
1549                                if ($h12 == 0 && $hour)
1550                                {
1551                                        $h12 = 12;
1552                                }
1553                                if ($h12 == 0 && !$hour)
1554                                {
1555                                        $h12 = 0;
1556                                }
1557                        }
1558                        else
1559                        {
1560                                $h12 = $hour;
1561                        }
1562
1563                        if ($sec !== '')
1564                        {
1565                                $sec = ":$sec";
1566                        }
1567
1568                        return "$h12:$min$sec$ampm";
1569                }
1570
1571                // This is not the best place for it, but it needs to be shared bewteen Aeromail and SM
1572                /*!
1573                @function get_email_passwd_ex
1574                @abstract uses code in /email class msg to obtain the appropriate password for email
1575                @param  (none - it will abtain the info it needs on its own)
1576                */
1577                /*
1578                function get_email_passwd_ex()
1579                {
1580                        // ----  Create the email Message Class  if needed  -----
1581                        if (is_object($GLOBALS['phpgw']->msg))
1582                        {
1583                                $do_free_me = False;
1584                        }
1585                        else
1586                        {
1587                                $GLOBALS['phpgw']->msg = CreateObject('email.mail_msg');
1588                                $do_free_me = True;
1589                        }
1590                        // use the Msg class to obtain the appropriate password
1591                        $tmp_prefs = $GLOBALS['phpgw']->preferences->read();
1592                        if (!isset($tmp_prefs['email']['passwd']))
1593                        {
1594                                $email_passwd = $GLOBALS['phpgw_info']['user']['passwd'];
1595                        }
1596                        else
1597                        {
1598                                $email_passwd = $GLOBALS['phpgw']->msg->decrypt_email_passwd($tmp_prefs['email']['passwd']);
1599                        }
1600                        // cleanup and return
1601                        if ($do_free_me)
1602                        {
1603                                unset ($GLOBALS['phpgw']->msg);
1604                        }
1605                        return $email_passwd;
1606                }
1607                */
1608
1609                // This is not the best place for it, but it needs to be shared bewteen Aeromail and SM
1610                /*!
1611                @function create_emailpreferences
1612                @abstract create email preferences
1613                @discussion This is not the best place for it, but it needs to be shared between Aeromail and SM
1614                @param $prefs
1615                @param $account_id -optional defaults to : phpgw_info['user']['account_id']
1616                */
1617                function create_emailpreferences($prefs='',$accountid='')
1618                {
1619                        return $GLOBALS['phpgw']->preferences->create_email_preferences($accountid);
1620                        // ----  Create the email Message Class  if needed  -----
1621                        if (is_object($GLOBALS['phpgw']->msg))
1622                        {
1623                                $do_free_me = False;
1624                        }
1625                        else
1626                        {
1627                                $GLOBALS['phpgw']->msg = CreateObject('email.mail_msg');
1628                                $do_free_me = True;
1629                        }
1630
1631                        // this sets the preferences into the phpgw_info structure
1632                        $GLOBALS['phpgw']->msg->create_email_preferences();
1633
1634                        // cleanup and return
1635                        if ($do_free_me)
1636                        {
1637                                unset ($GLOBALS['phpgw']->msg);
1638                        }
1639                }
1640
1641                /*
1642                function create_emailpreferences($prefs,$accountid='')
1643                {
1644                        $account_id = get_account_id($accountid);
1645
1646                        // NEW EMAIL PASSWD METHOD (shared between SM and aeromail)
1647                        $prefs['email']['passwd'] = $this->get_email_passwd_ex();
1648
1649                        // Add default preferences info
1650                        if (!isset($prefs['email']['userid']))
1651                        {
1652                                if ($GLOBALS['phpgw_info']['server']['mail_login_type'] == 'vmailmgr')
1653                                {
1654                                        $prefs['email']['userid'] = $GLOBALS['phpgw']->accounts->id2name($account_id)
1655                                                . '@' . $GLOBALS['phpgw_info']['server']['mail_suffix'];
1656                                }
1657                                else
1658                                {
1659                                        $prefs['email']['userid'] = $GLOBALS['phpgw']->accounts->id2name($account_id);
1660                                }
1661                        }
1662                        // Set Server Mail Type if not defined
1663                        if (empty($GLOBALS['phpgw_info']['server']['mail_server_type']))
1664                        {
1665                                $GLOBALS['phpgw_info']['server']['mail_server_type'] = 'imap';
1666                        }
1667
1668                        // OLD EMAIL PASSWD METHOD
1669                        if (!isset($prefs['email']['passwd']))
1670                        {
1671                                $prefs['email']['passwd'] = $GLOBALS['phpgw_info']['user']['passwd'];
1672                        }
1673                        else
1674                        {
1675                                $prefs['email']['passwd'] = $this->decrypt($prefs['email']['passwd']);
1676                        }
1677                        // NEW EMAIL PASSWD METHOD Located at the begining of this function
1678
1679                        if (!isset($prefs['email']['address']))
1680                        {
1681                                $prefs['email']['address'] = $GLOBALS['phpgw']->accounts->id2name($account_id)
1682                                        . '@' . $GLOBALS['phpgw_info']['server']['mail_suffix'];
1683                        }
1684                        if (!isset($prefs['email']['mail_server']))
1685                        {
1686                                $prefs['email']['mail_server'] = $GLOBALS['phpgw_info']['server']['mail_server'];
1687                        }
1688                        if (!isset($prefs['email']['mail_server_type']))
1689                        {
1690                                $prefs['email']['mail_server_type'] = $GLOBALS['phpgw_info']['server']['mail_server_type'];
1691                        }
1692                        if (!isset($prefs['email']['imap_server_type']))
1693                        {
1694                                $prefs['email']['imap_server_type'] = $GLOBALS['phpgw_info']['server']['imap_server_type'];
1695                        }
1696                        // These sets the mail_port server variable
1697                        if ($prefs['email']['mail_server_type']=='imap')
1698                        {
1699                                $prefs['email']['mail_port'] = '143';
1700                        }
1701                        elseif ($prefs['email']['mail_server_type']=='pop3')
1702                        {
1703                                $prefs['email']['mail_port'] = '110';
1704                        }
1705                        elseif ($prefs['email']['mail_server_type']=='imaps')
1706                        {
1707                                $prefs['email']['mail_port'] = '993';
1708                        }
1709                        elseif ($prefs['email']['mail_server_type']=='pop3s')
1710                        {
1711                                $prefs['email']['mail_port'] = '995';
1712                        }
1713                        // This is going to be used to switch to the nntp class
1714                        if (isset($phpgw_info['flags']['newsmode']) &&
1715                                $GLOBALS['phpgw_info']['flags']['newsmode'])
1716                        {
1717                                $prefs['email']['mail_server_type'] = 'nntp';
1718                        }
1719                        // DEBUG
1720                        //echo "<br>prefs['email']['passwd']: " .$prefs['email']['passwd'] .'<br>';
1721                        return $prefs;
1722                }
1723                */
1724
1725                // This will be moved into the applications area.
1726                /*!
1727                @function check_code
1728                @abstract ?
1729                @discussion This will be moved into the applications area
1730                */
1731                function check_code($code)
1732                {
1733                        $s = '<br>';
1734                        switch ($code)
1735                        {
1736                                case 13:        $s .= lang('Your message has been sent');break;
1737                                case 14:        $s .= lang('New entry added sucessfully');break;
1738                                case 15:        $s .= lang('Entry updated sucessfully');        break;
1739                                case 16:        $s .= lang('Entry has been deleted sucessfully'); break;
1740                                case 18:        $s .= lang('Password has been updated');        break;
1741                                case 38:        $s .= lang('Password could not be changed');    break;
1742                                case 19:        $s .= lang('Session has been killed');  break;
1743                                case 27:        $s .= lang('Account has been updated'); break;
1744                                case 28:        $s .= lang('Account has been created'); break;
1745                                case 29:        $s .= lang('Account has been deleted'); break;
1746                                case 30:        $s .= lang('Your settings have been updated'); break;
1747                                case 31:        $s .= lang('Group has been added');     break;
1748                                case 32:        $s .= lang('Group has been deleted');   break;
1749                                case 33:        $s .= lang('Group has been updated');   break;
1750                                case 34:        $s .= lang('Account has been deleted') . '<p>'
1751                                                . lang('Error deleting %1 %2 directory',lang('users'),' '.lang('private').' ')
1752                                                . ',<br>' . lang('Please %1 by hand',lang('delete')) . '<br><br>'
1753                                                . lang('To correct this error for the future you will need to properly set the')
1754                                                . '<br>' . lang('permissions to the files/users directory')
1755                                                . '<br>' . lang('On *nix systems please type: %1','chmod 770 '
1756                                                . $GLOBALS['phpgw_info']['server']['files_dir'] . '/users/');
1757                                        break;
1758                                case 35:        $s .= lang('Account has been updated') . '<p>'
1759                                                . lang('Error renaming %1 %2 directory',lang('users'),
1760                                                ' '.lang('private').' ')
1761                                                . ',<br>' . lang('Please %1 by hand',
1762                                                lang('rename')) . '<br><br>'
1763                                                . lang('To correct this error for the future you will need to properly set the')
1764                                                . '<br>' . lang('permissions to the files/users directory')
1765                                                . '<br>' . lang('On *nix systems please type: %1','chmod 770 '
1766                                                . $GLOBALS['phpgw_info']['server']['files_dir'] . '/users/');
1767                                        break;
1768                                case 36:        $s .= lang('Account has been created') . '<p>'
1769                                                . lang('Error creating %1 %2 directory',lang('users'),
1770                                                ' '.lang('private').' ')
1771                                                . ',<br>' . lang('Please %1 by hand',
1772                                                lang('create')) . '<br><br>'
1773                                                . lang('To correct this error for the future you will need to properly set the')
1774                                                . '<br>' . lang('permissions to the files/users directory')
1775                                                . '<br>' . lang('On *nix systems please type: %1','chmod 770 '
1776                                                . $GLOBALS['phpgw_info']['server']['files_dir'] . '/users/');
1777                                        break;
1778                                case 37:        $s .= lang('Group has been added') . '<p>'
1779                                                . lang('Error creating %1 %2 directory',lang('groups'),' ')
1780                                                . ',<br>' . lang('Please %1 by hand',
1781                                                lang('create')) . '<br><br>'
1782                                                . lang('To correct this error for the future you will need to properly set the')
1783                                                . '<br>' . lang('permissions to the files/users directory')
1784                                                . '<br>' . lang('On *nix systems please type: %1','chmod 770 '
1785                                                . $GLOBALS['phpgw_info']['server']['files_dir'] . '/groups/');
1786                                        break;
1787                                case 38:        $s .= lang('Group has been deleted') . '<p>'
1788                                                . lang('Error deleting %1 %2 directory',lang('groups'),' ')
1789                                                . ',<br>' . lang('Please %1 by hand',
1790                                                lang('delete')) . '<br><br>'
1791                                                . lang('To correct this error for the future you will need to properly set the')
1792                                                . '<br>' . lang('permissions to the files/users directory')
1793                                                . '<br>' . lang('On *nix systems please type: %1','chmod 770 '
1794                                                . $GLOBALS['phpgw_info']['server']['files_dir'] . '/groups/');
1795                                        break;
1796                                case 39:        $s .= lang('Group has been updated') . '<p>'
1797                                                . lang('Error renaming %1 %2 directory',lang('groups'),' ')
1798                                                . ',<br>' . lang('Please %1 by hand',
1799                                                lang('rename')) . '<br><br>'
1800                                                . lang('To correct this error for the future you will need to properly set the')
1801                                                . '<br>' . lang('permissions to the files/users directory')
1802                                                . '<br>' . lang('On *nix systems please type: %1','chmod 770 '
1803                                                . $GLOBALS['phpgw_info']['server']['files_dir'] . '/groups/');
1804                                        break;
1805                                case 40: $s .= lang('You have not entered a title').'.';
1806                                        break;
1807                                case 41: $s .= lang('You have not entered a valid time of day').'.';
1808                                        break;
1809                                case 42: $s .= lang('You have not entered a valid date').'.';
1810                                        break;
1811                                case 43: $s .= lang('You have not entered participants').'.';
1812                                        break;
1813                                default:        return '';
1814                        }
1815                        return $s;
1816                }
1817                /*!
1818                @function phpgw_error
1819                @abstract process error message
1820                @param $error error
1821                @param $line line
1822                @param $file file
1823                */
1824                function phpgw_error($error,$line = '', $file = '')
1825                {
1826                        echo '<p><b>phpGroupWare internal error:</b><p>'.$error;
1827                        if ($line)
1828                        {
1829                                echo 'Line: '.$line;
1830                        }
1831                        if ($file)
1832                        {
1833                                echo 'File: '.$file;
1834                        }
1835                        echo '<p>Your session has been halted.';
1836                        exit;
1837                }
1838
1839                /*!
1840                @function create_phpcode_from_array
1841                @abstract create phpcode from array
1842                @param $array - array
1843                */
1844                function create_phpcode_from_array($array)
1845                {
1846                        while (list($key, $val) = each($array))
1847                        {
1848                                if (is_array($val))
1849                                {
1850                                        while (list($key2, $val2) = each($val))
1851                                        {
1852                                                if (is_array($val2))
1853                                                {
1854                                                        while (list($key3, $val3) = each ($val2))
1855                                                        {
1856                                                                if (is_array($val3))
1857                                                                {
1858                                                                        while (list($key4, $val4) = each ($val3))
1859                                                                        {
1860                                                                                $s .= '$phpgw_info["' . $key . '"]["' . $key2 . '"]["' . $key3 . '"]["' .$key4 . '"]="' . $val4 . '";';
1861                                                                                $s .= "\n";
1862                                                                        }
1863                                                                }
1864                                                                else
1865                                                                {
1866                                                                        $s .= '$phpgw_info["' . $key . '"]["' . $key2 . '"]["' . $key3 . '"]="' . $val3 . '";';
1867                                                                        $s .= "\n";
1868                                                                }
1869                                                        }
1870                                                }
1871                                                else
1872                                                {
1873                                                        $s .= '$phpgw_info["' . $key .'"]["' . $key2 . '"]="' . $val2 . '";';
1874                                                        $s .= "\n";
1875                                                }
1876                                        }
1877                                }
1878                                else
1879                                {
1880                                        $s .= '$phpgw_info["' . $key . '"]="' . $val . '";';
1881                                        $s .= "\n";
1882                                }
1883                        }
1884                        return $s;
1885                }
1886
1887                // This will return the full phpgw_info array, used for debugging
1888                /*!
1889                @function debug_list_array_contents
1890                @abstract return the full phpgw_info array for debugging
1891                @param array - array
1892                */
1893                function debug_list_array_contents($array)
1894                {
1895                        while (list($key, $val) = each($array))
1896                        {
1897                                if (is_array($val))
1898                                {
1899                                        while (list($key2, $val2) = each($val))
1900                                        {
1901                                                if (is_array($val2))
1902                                                {
1903                                                        while (list($key3, $val3) = each ($val2))
1904                                                        {
1905                                                                if (is_array($val3))
1906                                                                {
1907                                                                        while (list($key4, $val4) = each ($val3))
1908                                                                        {
1909                                                                                echo $$array . "[$key][$key2][$key3][$key4]=$val4<br>";
1910                                                                        }
1911                                                                }
1912                                                                else
1913                                                                {
1914                                                                        echo $$array . "[$key][$key2][$key3]=$val3<br>";
1915                                                                }
1916                                                        }
1917                                                }
1918                                                else
1919                                                {
1920                                                        echo $$array . "[$key][$key2]=$val2<br>";
1921                                                }
1922                                        }
1923                                }
1924                                else
1925                                {
1926                                        echo $$array . "[$key]=$val<br>";
1927                                }
1928                        }
1929                }
1930
1931                // This will return a list of functions in the API
1932                /*!
1933                @function debug_list_core_functions
1934                @abstract return a list of functionsin the API
1935                */
1936                function debug_list_core_functions()
1937                {
1938                        echo '<br><b>core functions</b><br>';
1939                        echo '<pre>';
1940                        chdir(PHPGW_INCLUDE_ROOT . '/phpgwapi');
1941                        system("grep -r '^[ \t]*function' *");
1942                        echo '</pre>';
1943                }
1944
1945                // This will return a value for the next id an app/class may need to insert values into ldap.
1946                /*!
1947                @function next_id
1948                @abstract return the next higher value for an integer, and increment it in the db.
1949                */
1950                function next_id($appname,$min=0,$max=0)
1951                {
1952                        if (!$appname)
1953                        {
1954                                return -1;
1955                        }
1956
1957                        $GLOBALS['phpgw']->db->query("SELECT id FROM phpgw_nextid WHERE appname='".$appname."'",__LINE__,__FILE__);
1958                        while( $GLOBALS['phpgw']->db->next_record() )
1959                        {
1960                                $id = $GLOBALS['phpgw']->db->f('id');
1961                        }
1962
1963                        if (empty($id) || !$id)
1964                        {
1965                                $id = 1;
1966                                $GLOBALS['phpgw']->db->query("INSERT INTO phpgw_nextid (appname,id) VALUES ('".$appname."',".$id.")",__LINE__,__FILE__);
1967                        }
1968                        elseif($id<$min)
1969                        {
1970                                $id = $min;
1971                                $GLOBALS['phpgw']->db->query("UPDATE phpgw_nextid SET id=".$id." WHERE appname='".$appname."'",__LINE__,__FILE__);
1972                        }
1973                        elseif ($max && ($id > $max))
1974                        {
1975                                return False;
1976                        }
1977                        else
1978                        {
1979                                $id = $id + 1;
1980                                $GLOBALS['phpgw']->db->query("UPDATE phpgw_nextid SET id=".$id." WHERE appname='".$appname."'",__LINE__,__FILE__);
1981                        }
1982
1983                        return (int)$id;
1984                }
1985
1986                // This will return a value for the last id entered, which an app may need to check
1987                // values for ldap.
1988                /*!
1989                @function last_id
1990                @abstract return the current id in the next_id table for a particular app/class.
1991                */
1992                function last_id($appname,$min=0,$max=0)
1993                {
1994                        if (!$appname)
1995                        {
1996                                return -1;
1997                        }
1998
1999                        $GLOBALS['phpgw']->db->query("SELECT id FROM phpgw_nextid WHERE appname='".$appname."'",__LINE__,__FILE__);
2000                        while( $GLOBALS['phpgw']->db->next_record() )
2001                        {
2002                                $id = $GLOBALS['phpgw']->db->f('id');
2003                        }
2004
2005                        if (empty($id) || !$id)
2006                        {
2007                                if($min)
2008                                {
2009                                        $id = $min;
2010                                }
2011                                else
2012                                {
2013                                        $id = 1;
2014                                }
2015                                $GLOBALS['phpgw']->db->query("INSERT INTO phpgw_nextid (appname,id) VALUES ('".$appname."',".$id.")",__LINE__,__FILE__);
2016                        }
2017                        elseif($id<$min)
2018                        {
2019                                $id = $min;
2020                                $GLOBALS['phpgw']->db->query("UPDATE phpgw_nextid SET id=".$id." WHERE appname='".$appname."'",__LINE__,__FILE__);
2021                        }
2022                        elseif ($max && ($id > $max))
2023                        {
2024                                return False;
2025                        }
2026                        return (int)$id;
2027                }
2028        }//end common class
Note: See TracBrowser for help on using the repository browser.