]>
src.bluestatic.org Git - bugdar.git/blob - includes/functions.php
2 /*=====================================================================*\
3 || ###################################################################
5 || # Copyright (c)2002-2007 Blue Static
7 || # This program is free software; you can redistribute it and/or modify
8 || # it under the terms of the GNU General Public License as published by
9 || # the Free Software Foundation; version 2 of the License.
11 || # This program is distributed in the hope that it will be useful, but
12 || # WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
13 || # or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
16 || # You should have received a copy of the GNU General Public License along
17 || # with this program; if not, write to the Free Software Foundation, Inc.,
18 || # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
19 || ###################################################################
20 \*=====================================================================*/
22 // ###################################################################
24 * Constructs HTML code <select>s from an array. You use they keys when
25 * you need to access a multi-dimensional array of data.
29 * @param string HTML name of the select
30 * @param array Array of <option>s
31 * @param integer ID of the selected item, 0 for none
32 * @param string Name of the index where values are stored in the $array
33 * @param string Name of the iddex where the labels are stored in $array
34 * @param bool Value of the blank option, FALSE turns it off
35 * @param bool Construct a multiple-selection <select> menu and append "[]" to the end of the name
37 * @return string Constructed HTML output
39 function construct_option_select ( $name , $array , $selected = 0 , $valuekey = '' , $labelkey = '' , $includenil = false , $multiple = false )
45 $selected = explode ( ',' , $selected );
48 // if we're not working on a boolean false, we use it for the value (allows -1 and 0)
49 if ( $includenil !== false )
51 $opts [] = '<option value="' . $includenil . '"' . ((! $selected OR ( is_array ( $selected ) AND in_array ( $includenil , $selected ))) ? ' selected="selected"' : '' ) . '> ---------</option>' ;
53 foreach ( $array AS $value => $label )
55 $newval = ( $valuekey ? $label [ " $valuekey" ] : $value );
56 $newlab = ( $labelkey ? $label [" $labelkey" ] : $label );
57 $opts [] = '<option value="' . $newval . '"' . (( $selected == $newval OR ( is_array ( $selected ) AND in_array ( $newval , $selected ))) ? ' selected="selected"' : '' ) . '>' . $newlab . '</option>' ;
59 return '<select class="input" name="' . $name . ( $multiple ? '[]' : '' ) . '"' . ( $multiple ? ' multiple="multiple" size="' . ( sizeof ( $array ) < 8 ? sizeof ( $array ) +
1 : 8 ) . '"' : '' ) . '>' . implode ( " \n\t " , $opts ) . " \r </select>" ;
62 // ################### Start construct_user_display ##################
63 // $userinfo needs userid, email, displayname, and showemail
64 function construct_user_display ( $userinfo , $html = true )
68 if (! $userinfo [ 'userid' ])
70 $userinfo [ 'displayname' ] = T ( 'Guest' );
71 $userinfo [ 'showemail' ] = false ;
76 eval ( ' $username = "' . $bugsys- > template
-> fetch ( 'username_display' ) . '";' );
80 if ( $userinfo [ 'showemail' ])
82 $username = sprintf ( T ( '%1 $s <%2 $s >' ), $userinfo [ 'displayname' ], $userinfo [ 'email' ]);
86 $username = $userinfo [ 'displayname' ];
93 // ######################## Start can_perform ########################
94 // short-hand for bitwise &
95 function can_perform ( $bitmask , $productid = 0 , $userinfo = null )
99 // masks that aren't product-specific
100 static $inspecific = array (
112 if ( $userinfo == null )
114 $userinfo =& $bugsys- > userinfo
;
117 $permissions =& bugdar
:: $datastore [ 'permission' ];
119 if (! isset ( $bugsys- > permissions
[ " $bitmask" ]))
121 trigger_error('Invalid bitmask " ' . $bitmask . ' " specified for can_perform() [includes/functions.php]', E_USER_WARNING);
124 if (! $userinfo ['permissions'])
126 $userinfo ['permissions'] = FetchUserPermissions( $userinfo );
129 if ( $productid AND !in_array( $bitmask , $inspecific ))
131 $verdict = (isset( $permissions [" $userinfo [ usergroupid
] "][" $productid" ]) ? ( $permissions [ " $userinfo [usergroupid]" ][ " $productid" ] & $bugsys- >permissions[" $bitmask" ]) : ( $userinfo [ 'permissions' ] & $bugsys- > permissions
[ " $bitmask" ]));
133 foreach ( $userinfo ['groupids'] AS $group )
135 if (isset( $permissions [" $group" ][ " $productid" ]))
137 $verdict |= ( $permissions [" $group" ][ " $productid" ] & $bugsys- >permissions[" $bitmask" ]);
140 $bugsys- > debug ( "verdict* on can_perform( $bitmask , $productid , $userinfo [userid]) = $verdict" );
144 $bugsys- >debug(" verdict on
can_perform ( $bitmask , $productid , $userinfo [ userid
]) = " . ( $userinfo ['permissions'] & $bugsys- >permissions[" $bitmask" ]));
145 return ( $userinfo [ 'permissions' ] & $bugsys- > permissions
[ " $bitmask" ]);
148 // ###################################################################
150 * Runs through a given datastore item and creates a series of <select>
155 * @param string Datastore name
156 * @param string Array index for the label
157 * @param string Array index for the value
158 * @param mixed The selected value(s)
159 * @param bool Include a blank option? TRUE will set a null value, FALSE turns it off, anything else is used as the value for the blank option
160 * @param bool Generate it using admin printers?
162 * @return string Unelss in admin mode, returns the constructed options
164 function construct_datastore_select( $datastore , $labelname , $valuename , $selectedvalue = 0, $includeblank = false, $adminmode = false)
175 if ( $includeblank === true OR $includeblank !== false)
177 $newval = ( $inclueblank === true ? '' : $includeblank );
180 $admin- >list_item('', '', ((! $selectedvalue OR (is_array( $selectedvalue ) AND in_array( $newval , $selectedvalue ))) ? true : false));
186 $selected = ((! $selectedvalue OR (is_array( $selectedvalue ) AND in_array( $newval , $selectedvalue ))) ? true : false);
187 eval(' $select .= " ' . $bugsys- >template->fetch(' selectoption
') . ' ";');
191 foreach (bugdar:: $datastore [" $datastore" ] AS $item )
193 $label = $item [ " $labelname" ];
194 $value = $item [" $valuename" ];
195 $selected = (( $value == $selectedvalue OR ( is_array ( $selectedvalue ) AND in_array ( $value , $selectedvalue ))) ? true : false );
199 $admin- > list_item ( $label , $value , $selected );
203 eval ( ' $select .= "' . $bugsys- > template
-> fetch ( 'selectoption' ) . '";' );
213 // ################## Start construct_custom_fields ##################
214 function construct_custom_fields ( $bug = array (), $ignore21mask = false , $nodefault = false , $searchMode = false )
219 if (! is_array ( $fields ))
222 $fields_fetch = $bugsys- > db
-> query ( "
223 SELECT bugfield.*, MAX(permission.mask) AS mask
224 FROM " . TABLE_PREFIX
. "bugfield AS bugfield
225 LEFT JOIN " . TABLE_PREFIX
. "bugfieldpermission AS permission
226 ON (bugfield.fieldid = permission.fieldid)
227 WHERE (permission.mask = 2 OR permission.mask = 1)
228 AND permission.usergroupid IN ( {$bugsys->userinfo['usergroupid']} " . ( sizeof ( $bugsys- > userinfo
[ 'groupids' ]) != 0 ? ',' . implode ( ',' , $bugsys- > userinfo
[ 'groupids' ]) : '' ) . ")
229 GROUP BY (bugfield.fieldid)
231 while ( $field = $bugsys- > db
-> fetch_array ( $fields_fetch ))
233 $fields [ " $field [fieldid]" ] = $field ;
237 $fieldbits = array ();
239 foreach ( $fields AS $field )
243 $field [ 'defaultvalue' ] = '' ;
246 if (! is_null ( $bug [ "custom $field [fieldid]" ]))
248 $bugsys- > debug ( "not null: $field [fieldid]" );
249 $value = $bug [ "custom $field [fieldid]" ];
253 $value = $field [ 'defaultvalue' ];
256 if ( $ignore21mask AND $field [ 'mask' ] != 0 )
261 if ( $field [ 'mask' ] == 2 )
263 switch ( $field [ 'type' ])
266 eval ( ' $tempfield = "' . $bugsys- > template
-> fetch ( 'bugfield_input_text' ) . '";' );
269 case 'input_checkbox' :
270 $selected = ( $value ? ' checked="checked"' : '' );
271 eval ( ' $tempfield = "' . $bugsys- > template
-> fetch ( 'bugfield_input_checkbox' ) . '";' );
274 case 'select_single' :
275 $selects = unserialize ( $field [ 'selects' ]);
276 $value = trim ( $value );
280 // this overrides $field['usedefault'] because required fields will no longer have
281 // blank values as options
282 // TODO document above comment in the ACP
283 if (! $field [ 'required' ])
287 if (! $field [ 'usedefault' ] && ! trim ( $value ))
289 $selected = ' selected="selected"' ;
295 eval ( ' $options .= "' . $bugsys- > template
-> fetch ( 'bugfield_select_single_option' ) . '";' );
298 foreach ( $selects AS $id => $select )
301 $select = stripslashes ( trim ( $select ));
302 if ( $select == $value )
304 $selected = ' selected="selected"' ;
306 else if ( $field [ 'usedefault' ] AND $id == 0 )
308 $selected = ' selected="selected"' ;
310 eval ( ' $options .= "' . $bugsys- > template
-> fetch ( 'bugfield_select_single_option' ) . '";' );
312 eval ( ' $tempfield = "' . $bugsys- > template
-> fetch ( 'bugfield_select_single' ) . '";' );
318 $bugsys- > debug ( 'mask 1 processing' );
319 if ( is_null ( $bug [ "custom $field [fieldid]" ]))
321 $bugsys- > debug ( "is null: $field [fieldid]" );
322 if ( $field [ 'type' ] == 'select_single' )
324 if ( $field [ 'usedefault' ])
326 $temp = unserialize ( $field [ 'selects' ]);
327 $value = trim ( $temp [ 0 ]);
331 $value = $bug [ "custom $field [fieldid]" ];
336 $value = $field [ 'defaultvalue' ];
341 $value = $bug [ "custom $field [fieldid]" ];
344 if ( $field [ 'type' ] == 'input_checkbox' )
346 $value = ( $value ? 'True' : 'False' );
348 $field [ 'value' ] = $value ;
349 eval ( ' $tempfield = "' . $bugsys- > template
-> fetch ( 'bugfield_static_text' ) . '";' );
351 $fieldbits [] = $tempfield ;
357 // ###################################################################
359 * This takes the bug API object and input data and then sanitizes, verifies,
360 * and processes the data for custom fields. If there are any errors,
361 * they are passed to the message reporter.
363 * @param object A BugAPI object
364 * @param object MessageReporter object
365 * @param bool If there are errors, add them to an errorbox format? If not, then display-on-encounter
366 * @param bool Search mode: don't change certain fields when they're 0 or empty
368 * @return mixed NULL if an ID is passed, string if bugid is NULL
370 function process_custom_fields (& $bugapi , & $msg , $errorbox = false , $searchMode = false )
376 $inputdata =& $bugsys- > in
;
379 $fields = $bugsys- > db
-> query ( "
380 SELECT bugfield.*, MAX(permission.mask) AS mask
381 FROM " . TABLE_PREFIX
. "bugfield AS bugfield
382 LEFT JOIN " . TABLE_PREFIX
. "bugfieldpermission AS permission
383 ON (bugfield.fieldid = permission.fieldid)
384 WHERE permission.mask = 2
385 AND permission.usergroupid IN ( {$bugsys->userinfo['usergroupid']} " . ( sizeof ( $bugsys- > userinfo
[ 'groupids' ]) != 0 ? ',' . implode ( ',' , $bugsys- > userinfo
[ 'groupids' ]) : '' ) . ")
386 GROUP BY (bugfield.fieldid)
388 while ( $field = $bugsys- > db
-> fetch_array ( $fields ))
390 $fieldname = "custom $field [fieldid]" ;
392 if ( $field [ 'type' ] == 'input_checkbox' )
394 if ( $searchMode AND intval ( $inputdata [ " $fieldname" ]) == 0)
398 $bugapi- >set( $fieldname , intval( $inputdata [" $fieldname" ]));
401 else if ( $field [ 'type' ] == 'select_single' )
403 $temp = unserialize ( $field [ 'selects' ]);
404 $inputdata [ $fieldname ] = $temp [ intval ( $inputdata [ " $fieldname" ])] . ''; // make it a string so isset() doesn't catch
407 // field data wasn't passed, so skip it
408 if (!isset( $inputdata [" $fieldname" ]))
413 if ( $field [ 'required' ] AND empty ( $inputdata [ " $fieldname" ]) AND ! $searchMode )
415 $errorlist [] = sprintf(T('The field " %
1 $s" is a required
. '), $field [' name
']);
419 if (!empty( $field [' regexmatch
']))
421 if (!preg_match(' #' . str_replace('#', '\#', $field['regexmatch']) . '#si', $inputdata["$fieldname"]))
423 $errorlist [] = sprintf ( T ( '%1 $s does not match the specified format' ), $field [ 'name' ]);
428 if ( isset ( $inputdata [ " $fieldname" ]))
430 if ( $field ['type'] == 'input_text')
432 if (empty( $inputdata [" $fieldname" ]) AND $searchMode )
436 $bugapi- > set ( $fieldname , $inputdata [ " $fieldname" ]);
440 if (empty( $inputdata [" $fieldname" ]))
444 $bugapi- > set ( $fieldname , '' );
449 $bugapi- > set ( $fieldname , trim ( $inputdata [ " $fieldname" ]));
458 foreach ( $errorlist AS $err )
460 $msg- >addError( $err );
465 $msg- >error( $errorlist [0]);
470 // ####################### Start fetch_on_bits #######################
471 function fetch_on_bits( $mask , $userinfo = null)
475 if ( $userinfo == null)
477 $userinfo =& $bugsys- >userinfo;
482 $usergroupid = $userinfo ['usergroupid'];
483 FetchUserPermissions( $userinfo ); // get the groups
484 $groups = $userinfo ['groupids'];
485 $groups [] = $usergroupid ;
487 // product-inspecific work
488 if (is_array(bugdar:: $datastore ['product']))
490 foreach ( $groups AS $groupid )
492 // we only need to do this so long as there's no onbits array because this isn't product specific
493 if (sizeof( $onbits ) == 0 AND bugdar:: $datastore ['usergroup'][" $groupid" ][ 'permissions' ] & $bugsys- > permissions
[ " $mask" ])
495 foreach (bugdar:: $datastore ['product'] AS $id => $product )
497 $onbits [" $id" ] = $id ;
503 // bits set explicitly by products
506 // product specific work
507 foreach ( $groups AS $groupid )
509 if ( is_array ( bugdar
:: $datastore [ 'permission' ][ " $groupid" ]))
511 foreach (bugdar:: $datastore ['permission'][" $groupid" ] AS $productid => $bit )
513 if ( $bit & $bugsys- > permissions
[ " $mask" ])
515 $explicit [" $productid" ] = $productid ;
516 $onbits [ " $productid" ] = $productid ;
520 // only unset if the bit was set in the first place by blanket and not product-specific permissions
521 // if it was set by product permissions then the highest level takes precedence
522 if ( $onbits [" $productid" ] AND ! isset ( $explicit [ " $productid" ]))
524 unset( $onbits [" $productid" ]);
531 // SQL queries would become very unhappy if we didn't do this
532 if ( sizeof ( $onbits ) < 1 )
537 return implode ( ',' , $onbits );
540 // #################### Start isso_pre_parse_hook ####################
541 // the pre-parse hook for ISSO's template engine
542 function isso_pre_parse_hook ( $template )
544 $template = preg_replace ( '# \$ help\[(.*)\]#' , '" . fetch_help_link("\1") . "' , $template );
548 // ###################### Start fetch_help_link ######################
549 // returns a prepared link to insert into templates that opens up a
550 // help popup in the user-end
551 function fetch_help_link ( $topic )
555 if ( isset ( bugdar
:: $datastore [ 'help' ][ " $topic" ]))
557 eval(' $temp = " ' . $bugsys- >template->fetch(' help_link
') . ' ";');
564 return " [[ INVALID TOPIC
: $topic ]] ";
569 return eval(' $temp = " ' . $bugsys- >template->fetch(' help_link
') . ' ";');
574 // ###################################################################
576 * Returns a user array of information that is specific to all visiting
577 * users (guests). This can then be passed to any function that requires
582 * @return array User information array
584 function fetch_guest_user()
590 'groupids' => array(),
595 'permissions' => bugdar:: $datastore ['usergroup'][1]['permissions'],
596 'displaytitle' => bugdar:: $datastore ['usergroup'][1]['displaytitle'],
597 'timezone' => $bugsys- >options['defaulttimezone']
601 // ###################################################################
603 * Does an exhaustive permissions check on the bug. It checks for hidden
604 * bug status and ability to view hidden bugs. This normally was done
605 * at the top of each page, but it got so big, it was moved to a function.
609 * @param array Bug array
610 * @param array Alternate user array
612 * @return bool Does the user have permission
614 function check_bug_permissions( $bug , $userinfo = null)
617 if ( $userinfo == null)
619 $userinfo = $bugsys- >userinfo;
622 $bugsys- >debug(" checking permissions
for $userinfo [ userid
] on bug
$bug [ bugid
] ");
624 $bugsys- >debug('*** START VERBOSE CHECK ***');
626 $bugsys- >debug('* !can_perform(canviewbugs, $bug [product], $userinfo ) = ' . (int)(!can_perform('canviewbugs', $bug ['product'], $userinfo )));
627 $bugsys- >debug('* $bug [hidden] = ' . (int) $bug ['hidden']);
628 $bugsys- >debug('* $userinfo [userid] (' . $userinfo ['userid'] . ') == $bug [userid] (' . $bug ['userid'] . ') = ' . (int)( $userinfo ['userid'] == $bug ['userid']));
629 $bugsys- >debug('* can_perform(canviewownhidden, $bug [product], $userinfo ) = ' . (int)(!!can_perform('canviewownhidden', $bug ['product'], $userinfo )));
630 $bugsys- >debug('* can_perform(canviewhidden, $bug [product], $userinfo ) = ' . (int)(!!can_perform('canviewhidden', $bug ['product'], $userinfo )));
631 $bugsys- >debug('* ! $bug [hidden] = ' . (int)(! $bug ['hidden']));
633 $bugsys- >debug('*** END PERMISSIONS CHECK ***');
635 if (!can_perform('canviewbugs', $bug ['product'], $userinfo )) {
636 $bugsys- >debug('*** DONE WITH REAL CALLS ***');
640 if ( $bug ['hidden']) {
641 if (can_perform('canviewhidden', $bug ['product'], $userinfo )) {
642 $bugsys- >debug('*** DONE WITH REAL CALLS ***');
644 } else if ( $userinfo ['userid'] == $bug ['userid'] AND can_perform('canviewownhidden', $bug ['product'], $userinfo )) {
645 $bugsys- >debug('*** DONE WITH REAL CALLS ***');
648 $bugsys- >debug('*** DONE WITH REAL CALLS ***');
653 $bugsys- >debug('*** DONE WITH REAL CALLS ***');
657 // ###################################################################
659 * Takes an array of bug information and returns another array with
660 * information that is suitable for display as all the IDs have been
661 * replaced by their string equivalents
663 * @param array Unprocessed bug data
664 * @param string Color to display if the user has opted to not show status colours
666 * @param array Bug array with data fit for display
668 function ProcessBugDataForDisplay( $bug , $color = '')
672 $bug ['hiddendisplay'] = ( $bug ['hidden'] AND (can_perform('canviewhidden', $bug ['product']) OR (can_perform('canviewownhidden') AND $bug ['userid'] == $bugsys- >userinfo['userid'])));
674 $bug ['bgcolor'] = ( $bugsys- >userinfo['showcolors'] ? bugdar:: $datastore ['status'][" $bug [ status
] "]['color'] : $color );
675 $bug ['product'] = bugdar:: $datastore ['product'][" $bug [ product
] "]['title'];
676 $bug ['version'] = bugdar:: $datastore ['version'][" $bug [ version
] "]['version'];
677 $bug ['component'] = bugdar:: $datastore ['component'][" $bug [ component
] "]['title'];
678 $bug ['status'] = bugdar:: $datastore ['status'][" $bug [ status
] "]['status'];
679 $bug ['resolution'] = bugdar:: $datastore ['resolution'][" $bug [ resolution
] "]['resolution'];
680 $bug ['priority'] = bugdar:: $datastore ['priority'][" $bug [ priority
] "]['priority'];
681 $bug ['severity'] = bugdar:: $datastore ['severity'][" $bug [ severity
] "]['severity'];
682 $bug ['assignedto'] = ((empty( $bug ['assignedto']) OR !isset(bugdar:: $datastore ['assignto'][" $bug [ assignedto
] "])) ? '' : construct_user_display(bugdar:: $datastore ['assignto'][" $bug [ assignedto
] "]));
684 $bug ['lastposttime'] = ( $bug ['hiddendisplay'] ? $bug ['hiddenlastposttime'] : $bug ['lastposttime']);
685 $bug ['lastpost'] = ( $bug ['hiddendisplay'] ? $bug ['hiddenlastpostbyname'] : $bug ['lastpostbyname']);
687 $bug ['lastposttime'] = $bugsys- >datef->format( $bugsys- >options['dateformat'], $bug ['lastposttime']);
692 // ###################################################################
694 * Loads the pagination module and sets all of the appropriate options
699 function LoadPaginationFramework()
703 $bugsys- >load('pagination', 'pagination', true);
704 $bugsys- >pagination->setDefaultPerPage( $bugsys- >options['defaultpp']);
705 $bugsys- >pagination->setMaxPerPage( $bugsys- >options['maxpp']);
706 $bugsys- >pagination->setPageLinks( $bugsys- >options['pagelinks']);
707 $bugsys- >pagination->setPageVar('p');
708 $bugsys- >pagination->setPerPageVar('pp');
709 $bugsys- >pagination->setBitProcessor('PageNavigatorBitCallback');
710 $bugsys- >pagination->setNavigatorProcessor('PageNavigatorCallback');
711 $bugsys- >pagination->processIncomingData();
714 // ###################################################################
716 * Callback function for the Pagination->BitProcessor()
718 * @param string Base link
719 * @param bool Do not show this as a link
720 * @param integer Page number
721 * @param object Page navigator framework
723 * @return string Processed HTML
725 function PageNavigatorBitCallback( $baselink , $nolink , $number , $paginator )
728 eval(' $return = " ' . $bugsys- >template->fetch(' pagenav_bit
') . ' ";');
732 // ###################################################################
734 * Callback function for the Pagination->NavigatorProcessor()
736 * @param string Base URL
737 * @param integer Next page number
738 * @param integer Previous page number
739 * @param array Show information
740 * @param string Individual page bits
741 * @param object Page navigator framework
743 * @return string Processed HTML
745 function PageNavigatorCallback( $baselink , $nextpage , $prevpage , $show , $pagebits , $paginator )
748 eval(' $return = " ' . $bugsys- >template->fetch(' pagenav
') . ' ";');
752 // ###################################################################
754 * Determines the correct permissions of the user. This is especially
755 * important for working with multiple-usergroup permission schemes.
756 * If a user is assigned to more than one usergroup, the highest level
757 * will always override (so a YES will always override a NO); this is
758 * because permissions are calculated with bitwise OR.
760 * @param array The user array with usergroups already exploded
762 * @return integer Permissions value
764 function FetchUserPermissions(& $user )
768 $perms = (int)bugdar:: $datastore ['usergroup'][" $user [ usergroupid
] "]['permissions'];
769 if (!is_array( $user ['groupids']))
771 $user ['groupids'] = explode(',', $bugsys- >userinfo['groupids']);
773 $user ['groupids'] = $bugsys- >funct->array_strip_empty( $user ['groupids']);
775 foreach ( $user ['groupids'] AS $group )
777 $perms |= (int)bugdar:: $datastore ['usergroup'][" $group" ][ 'permissions' ];
783 // ###################################################################
785 * Fetches the path for an email template, given the name of the
786 * template and the locale to use
788 * @param string The template name
789 * @param string Language locale code
791 * @return string Template path
793 function FetchEmailPath ( $name , $locale )
795 return '../locale/' . $locale . '/emails/' . $name ;