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

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

Internacionalização das mensagens de erros.

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