Context Navigation

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

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

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

Download in other formats: