Context Navigation

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

Revision 2549, 62.1 KB checked in by rodsouza, 14 years ago (diff)
Ticket #1009 - Corrigindo problemas com a inclusão de javascript.
Property svn:eol-style set to `native` Property svn:executable set to ``*

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

Note: See TracBrowser for help on using the repository browser.

Download in other formats: