Context Navigation

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

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

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

Download in other formats: