2 /*=====================================================================*\
3 || ###################################################################
5 || # Copyright ©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 $tpl = new BSTemplate('username_display');
77 $tpl->vars
= array('userinfo' => $userinfo);
78 $username = $tpl->evaluate()->getTemplate();
82 if ($userinfo['showemail'])
84 $username = sprintf(T('%1$s <%2$s>'), $userinfo['displayname'], $userinfo['email']);
88 $username = $userinfo['displayname'];
95 // ######################## Start can_perform ########################
96 // short-hand for bitwise &
97 function can_perform($bitmask, $productid = 0, $userinfo = null
)
101 // masks that aren't product-specific
102 static $inspecific = array(
114 if ($userinfo == null
)
116 $userinfo =& bugdar
::$userinfo;
119 $permissions =& bugdar
::$datastore['permission'];
121 if (!isset($bugsys->permissions
["$bitmask"]))
123 trigger_error('Invalid bitmask "' . $bitmask . '" specified for can_perform() [includes/functions.php]', E_USER_WARNING
);
126 if (!$userinfo['permissions'])
128 $userinfo['permissions'] = FetchUserPermissions($userinfo);
131 if ($productid AND !in_array($bitmask, $inspecific))
133 $verdict = (isset($permissions["$userinfo[usergroupid]"]["$productid"]) ?
($permissions["$userinfo[usergroupid]"]["$productid"] & $bugsys->permissions
["$bitmask"]) : ($userinfo['permissions'] & $bugsys->permissions
["$bitmask"]));
135 foreach ($userinfo['groupids'] AS $group)
137 if (isset($permissions["$group"]["$productid"]))
139 $verdict |
= ($permissions["$group"]["$productid"] & $bugsys->permissions
["$bitmask"]);
142 $bugsys->debug("verdict* on can_perform($bitmask, $productid, $userinfo[userid]) = $verdict");
146 BSApp
::debug("verdict on can_perform($bitmask, $productid, $userinfo[userid]) = " . ($userinfo['permissions'] & $bugsys->permissions
["$bitmask"]));
147 return ($userinfo['permissions'] & $bugsys->permissions
["$bitmask"]);
150 // ###################################################################
152 * Runs through a given datastore item and creates a series of <select>
157 * @param string Datastore name
158 * @param string Array index for the label
159 * @param string Array index for the value
160 * @param mixed The selected value(s)
161 * @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
162 * @param bool Generate it using admin printers?
164 * @return string Unelss in admin mode, returns the constructed options
166 function construct_datastore_select($datastore, $labelname, $valuename, $selectedvalue = 0, $includeblank = false
, $adminmode = false
)
177 if ($includeblank === true
OR $includeblank !== false
)
179 $newval = ($inclueblank === true ?
'' : $includeblank);
182 $admin->list_item('', '', ((!$selectedvalue OR (is_array($selectedvalue) AND in_array($newval, $selectedvalue))) ? true
: false
));
188 $selected = ((!$selectedvalue OR (is_array($selectedvalue) AND in_array($newval, $selectedvalue))) ? true
: false
);
189 eval('$select .= "' . $bugsys->template
->fetch('selectoption') . '";');
193 foreach (bugdar
::$datastore["$datastore"] AS $item)
195 $label = $item["$labelname"];
196 $value = $item["$valuename"];
197 $selected = (($value == $selectedvalue OR (is_array($selectedvalue) AND in_array($value, $selectedvalue))) ? true
: false
);
201 $admin->list_item($label, $value, $selected);
205 eval('$select .= "' . $bugsys->template
->fetch('selectoption') . '";');
215 // ################## Start construct_custom_fields ##################
216 function construct_custom_fields($bug = array(), $ignore21mask = false
, $nodefault = false
, $searchMode = false
)
221 if (!is_array($fields))
224 $fields_fetch = $bugsys->db
->query("
225 SELECT bugfield.*, MAX(permission.mask) AS mask
226 FROM " . TABLE_PREFIX
. "bugfield AS bugfield
227 LEFT JOIN " . TABLE_PREFIX
. "bugfieldpermission AS permission
228 ON (bugfield.fieldid = permission.fieldid)
229 WHERE (permission.mask = 2 OR permission.mask = 1)
230 AND permission.usergroupid IN (" . bugdar
::$userinfo['usergroupid'] . (sizeof(bugdar
::$userinfo['groupids']) != 0 ?
',' . implode(',', bugdar
::$userinfo['groupids']) : '') . ")
231 GROUP BY (bugfield.fieldid)
233 foreach ($fields_fetch as $field)
235 $fields["$field[fieldid]"] = $field;
239 $fieldbits = array();
241 foreach ($fields AS $field)
245 $field['defaultvalue'] = '';
248 if (!is_null($bug["custom$field[fieldid]"]))
250 $bugsys->debug("not null: $field[fieldid]");
251 $value = $bug["custom$field[fieldid]"];
255 $value = $field['defaultvalue'];
258 if ($ignore21mask AND $field['mask'] != 0)
263 if ($field['mask'] == 2)
265 switch ($field['type'])
268 eval('$tempfield = "' . $bugsys->template
->fetch('bugfield_input_text') . '";');
271 case 'input_checkbox':
272 $selected = ($value ?
' checked="checked"' : '');
273 eval('$tempfield = "' . $bugsys->template
->fetch('bugfield_input_checkbox') . '";');
276 case 'select_single':
277 $selects = unserialize($field['selects']);
278 $value = trim($value);
284 if (!$field['usedefault'] AND !trim($value))
286 $selected = ' selected="selected"';
292 eval('$options .= "' . $bugsys->template
->fetch('bugfield_select_single_option') . '";');
294 foreach ($selects AS $id => $select)
297 $select = stripslashes(trim($select));
298 if ($select == $value)
300 $selected = ' selected="selected"';
302 else if ($field['usedefault'] AND $id == 0)
304 $selected = ' selected="selected"';
306 eval('$options .= "' . $bugsys->template
->fetch('bugfield_select_single_option') . '";');
308 eval('$tempfield = "' . $bugsys->template
->fetch('bugfield_select_single') . '";');
314 $bugsys->debug('mask 1 processing');
315 if (is_null($bug["custom$field[fieldid]"]))
317 $bugsys->debug("is null: $field[fieldid]");
318 if ($field['type'] == 'select_single')
320 if ($field['usedefault'])
322 $temp = unserialize($field['selects']);
323 $value = trim($temp[0]);
327 $value = $bug["custom$field[fieldid]"];
332 $value = $field['defaultvalue'];
337 $value = $bug["custom$field[fieldid]"];
340 if ($field['type'] == 'input_checkbox')
342 $value = ($value ?
'True' : 'False');
344 $field['value'] = $value;
345 eval('$tempfield = "' . $bugsys->template
->fetch('bugfield_static_text') . '";');
347 $fieldbits[] = $tempfield;
353 // ###################################################################
355 * This takes the bug API object and input data and then sanitizes, verifies,
356 * and processes the data for custom fields. If there are any errors,
357 * they are passed to the message reporter.
359 * @param object A BugAPI object
360 * @param object MessageReporter object
361 * @param bool If there are errors, add them to an errorbox format? If not, then display-on-encounter
362 * @param bool Search mode: don't change certain fields when they're 0 or empty
364 * @return mixed NULL if an ID is passed, string if bugid is NULL
366 function process_custom_fields(&$bugapi, &$msg, $errorbox = false
, $searchMode = false
)
372 $inputdata =& $bugsys->in
;
375 $fields = $bugsys->db
->query("
376 SELECT bugfield.*, MAX(permission.mask) AS mask
377 FROM " . TABLE_PREFIX
. "bugfield AS bugfield
378 LEFT JOIN " . TABLE_PREFIX
. "bugfieldpermission AS permission
379 ON (bugfield.fieldid = permission.fieldid)
380 WHERE permission.mask = 2
381 AND permission.usergroupid IN (" . bugdar
::$userinfo['usergroupid'] . (sizeof(bugdar
::$userinfo['groupids']) != 0 ?
',' . implode(',', bugdar
::$userinfo['groupids']) : '') . ")
382 GROUP BY (bugfield.fieldid)
384 foreach ($fields as $field)
386 $fieldname = "custom$field[fieldid]";
388 if ($field['type'] == 'input_checkbox')
390 if ($searchMode AND intval($inputdata["$fieldname"]) == 0)
394 $bugapi->set($fieldname, intval($inputdata["$fieldname"]));
397 else if ($field['type'] == 'select_single')
399 $temp = unserialize($field['selects']);
400 $inputdata[$fieldname] = $temp[intval($inputdata["$fieldname"])] . ''; // make it a string so isset() doesn't catch
403 // field data wasn't passed, so skip it
404 if (!isset($inputdata["$fieldname"]))
409 if ($field['required'] AND empty($inputdata["$fieldname"]) AND !$searchMode)
411 $errorlist[] = sprintf(T('The field "%1$s" is a required.'), $field['name']);
415 if (!empty($field['regexmatch']))
417 if (!preg_match('#' . str_replace('#', '\#', $field['regexmatch']) . '#si', $inputdata["$fieldname"]))
419 $errorlist[] = sprintf(T('%1$s does not match the specified format'), $field['name']);
424 if (isset($inputdata["$fieldname"]))
426 if ($field['type'] == 'input_text')
428 if (empty($inputdata["$fieldname"]) AND $searchMode)
432 $bugapi->set($fieldname, $inputdata["$fieldname"]);
436 if (empty($inputdata["$fieldname"]))
440 $bugapi->set($fieldname, '');
445 $bugapi->set($fieldname, trim($inputdata["$fieldname"]));
454 foreach ($errorlist AS $err)
456 $msg->addError($err);
461 $msg->error($errorlist[0]);
466 // ####################### Start fetch_on_bits #######################
467 function fetch_on_bits($mask, $userinfo = null
)
471 if ($userinfo == null
)
473 $userinfo =& bugdar
::$userinfo;
478 $usergroupid = $userinfo['usergroupid'];
479 FetchUserPermissions($userinfo); // get the groups
480 $groups = $userinfo['groupids'];
481 $groups[] = $usergroupid;
483 // product-inspecific work
484 if (is_array(bugdar
::$datastore['product']))
486 foreach ($groups AS $groupid)
488 // we only need to do this so long as there's no onbits array because this isn't product specific
489 if (sizeof($onbits) == 0 AND bugdar
::$datastore['usergroup']["$groupid"]['permissions'] & $bugsys->permissions
["$mask"])
491 foreach (bugdar
::$datastore['product'] AS $id => $product)
493 $onbits["$id"] = $id;
499 // bits set explicitly by products
502 // product specific work
503 foreach ($groups AS $groupid)
505 if (is_array(bugdar
::$datastore['permission']["$groupid"]))
507 foreach (bugdar
::$datastore['permission']["$groupid"] AS $productid => $bit)
509 if ($bit & $bugsys->permissions
["$mask"])
511 $explicit["$productid"] = $productid;
512 $onbits["$productid"] = $productid;
516 // only unset if the bit was set in the first place by blanket and not product-specific permissions
517 // if it was set by product permissions then the highest level takes precedence
518 if ($onbits["$productid"] AND !isset($explicit["$productid"]))
520 unset($onbits["$productid"]);
527 // SQL queries would become very unhappy if we didn't do this
528 if (sizeof($onbits) < 1)
533 return implode(',', $onbits);
536 // #################### Start isso_pre_parse_hook ####################
537 // the pre-parse hook for ISSO's template engine
538 function isso_pre_parse_hook($template)
540 $template = preg_replace('#\$help\[(.*)\]#', '" . fetch_help_link("\1") . "', $template);
544 // ###################### Start fetch_help_link ######################
545 // returns a prepared link to insert into templates that opens up a
546 // help popup in the user-end
547 function fetch_help_link($topic)
551 if (isset(bugdar
::$datastore['help']["$topic"]))
553 eval('$temp = "' . $bugsys->template
->fetch('help_link') . '";');
560 return "[[INVALID TOPIC: $topic]]";
565 return eval('$temp = "' . $bugsys->template
->fetch('help_link') . '";');
570 // ###################################################################
572 * Returns a user array of information that is specific to all visiting
573 * users (guests). This can then be passed to any function that requires
578 * @return array User information array
580 function fetch_guest_user()
586 'groupids' => array(),
591 'permissions' => bugdar
::$datastore['usergroup'][1]['permissions'],
592 'displaytitle' => bugdar
::$datastore['usergroup'][1]['displaytitle'],
593 'timezone' => bugdar
::$options['defaulttimezone']
597 // ###################################################################
599 * Does an exhaustive permissions check on the bug. It checks for hidden
600 * bug status and ability to view hidden bugs. This normally was done
601 * at the top of each page, but it got so big, it was moved to a function.
605 * @param array Bug array
606 * @param array Alternate user array
608 * @return bool Does the user have permission
610 function check_bug_permissions($bug, $userinfo = null
)
613 if ($userinfo == null
)
615 $userinfo = bugdar
::$userinfo;
618 $bugsys->debug("checking permissions for $userinfo[userid] on bug $bug[bugid]");
620 $bugsys->debug('*** START VERBOSE CHECK ***');
622 $bugsys->debug('* !can_perform(canviewbugs, $bug[product], $userinfo) = ' . (int)(!can_perform('canviewbugs', $bug['product'], $userinfo)));
623 $bugsys->debug('* $bug[hidden] = ' . (int)$bug['hidden']);
624 $bugsys->debug('* $userinfo[userid] (' . $userinfo['userid'] . ') == $bug[userid] (' . $bug['userid'] . ') = ' . (int)($userinfo['userid'] == $bug['userid']));
625 $bugsys->debug('* can_perform(canviewownhidden, $bug[product], $userinfo) = ' . (int)(!!can_perform('canviewownhidden', $bug['product'], $userinfo)));
626 $bugsys->debug('* can_perform(canviewhidden, $bug[product], $userinfo) = ' . (int)(!!can_perform('canviewhidden', $bug['product'], $userinfo)));
627 $bugsys->debug('* !$bug[hidden] = ' . (int)(!$bug['hidden']));
629 $bugsys->debug('*** END PERMISSIONS CHECK ***');
633 !can_perform('canviewbugs', $bug['product'], $userinfo)
640 ($userinfo['userid'] == $bug['userid'] AND can_perform('canviewownhidden', $bug['product'], $userinfo))
642 can_perform('canviewhidden', $bug['product'], $userinfo)
650 $bugsys->debug('*** DONE WITH REAL CALLS ***');
654 $bugsys->debug('*** DONE WITH REAL CALLS ***');
659 // ###################################################################
661 * Takes an array of bug information and returns another array with
662 * information that is suitable for display as all the IDs have been
663 * replaced by their string equivalents
665 * @param array Unprocessed bug data
666 * @param string Color to display if the user has opted to not show status colours
668 * @param array Bug array with data fit for display
670 function ProcessBugDataForDisplay($bug, $color = '')
674 $bug['hiddendisplay'] = ($bug['hidden'] AND (can_perform('canviewhidden', $bug['product']) OR (can_perform('canviewownhidden') AND $bug['userid'] == bugdar
::$userinfo['userid'])));
676 $bug['bgcolor'] = (bugdar
::$userinfo['showcolors'] ? bugdar
::$datastore['status']["$bug[status]"]['color'] : $color);
677 $bug['product'] = bugdar
::$datastore['product']["$bug[product]"]['title'];
678 $bug['version'] = bugdar
::$datastore['version']["$bug[version]"]['version'];
679 $bug['component'] = bugdar
::$datastore['component']["$bug[component]"]['title'];
680 $bug['status'] = bugdar
::$datastore['status']["$bug[status]"]['status'];
681 $bug['resolution'] = bugdar
::$datastore['resolution']["$bug[resolution]"]['resolution'];
682 $bug['priority'] = bugdar
::$datastore['priority']["$bug[priority]"]['priority'];
683 $bug['severity'] = bugdar
::$datastore['severity']["$bug[severity]"]['severity'];
684 $bug['assignedto'] = ((empty($bug['assignedto']) OR !isset(bugdar
::$datastore['assignto']["$bug[assignedto]"])) ?
'' : construct_user_display(bugdar
::$datastore['assignto']["$bug[assignedto]"]));
686 $bug['lastposttime'] = ($bug['hiddendisplay'] ?
$bug['hiddenlastposttime'] : $bug['lastposttime']);
687 $bug['lastpost'] = ($bug['hiddendisplay'] ?
$bug['hiddenlastpostbyname'] : $bug['lastpostbyname']);
689 $bug['lastposttime'] = BSApp
::$date->format(bugdar
::$options['dateformat'], $bug['lastposttime']);
694 // ###################################################################
696 * Determines the correct permissions of the user. This is especially
697 * important for working with multiple-usergroup permission schemes.
698 * If a user is assigned to more than one usergroup, the highest level
699 * will always override (so a YES will always override a NO); this is
700 * because permissions are calculated with bitwise OR.
702 * @param array The user array with usergroups already exploded
704 * @return integer Permissions value
706 function FetchUserPermissions(&$user)
710 $perms = (int)bugdar
::$datastore['usergroup']["$user[usergroupid]"]['permissions'];
711 if (!is_array($user['groupids']))
713 $user['groupids'] = explode(',', bugdar
::$userinfo['groupids']);
715 $user['groupids'] = BSFunctions
::array_strip_empty($user['groupids']);
717 foreach ($user['groupids'] AS $group)
719 $perms |
= (int)bugdar
::$datastore['usergroup']["$group"]['permissions'];
725 // ###################################################################
727 * Fetches the path for an email template, given the name of the
728 * template and the locale to use
730 * @param string The template name
731 * @param string Language locale code
733 * @return string Template path
735 function FetchEmailPath($name, $locale)
737 return '../locale/' . $locale . '/emails/' . $name;
740 /*=====================================================================*\
741 || ###################################################################
744 || ###################################################################
745 \*=====================================================================*/