Context Navigation

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

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

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

Download in other formats: