Context Navigation

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

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

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

Download in other formats: