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>";
63 * Constructs the user information link
65 * @param array Userinfo array - requires userid, email, displayname, and showemail values
66 * @param bool Return HTML or just a string?
69 function construct_user_display($userinfo, $html = true
)
71 if (!$userinfo['userid'])
73 $userinfo['displayname'] = T('Guest');
74 $userinfo['showemail'] = false
;
79 $tpl = new BSTemplate('username_display');
80 $tpl->vars
= array('userinfo' => $userinfo);
81 $username = $tpl->evaluate()->getTemplate();
85 if ($userinfo['showemail'])
87 $username = sprintf(T('%1$s <%2$s>'), $userinfo['displayname'], $userinfo['email']);
91 $username = $userinfo['displayname'];
98 // ######################## Start can_perform ########################
99 // short-hand for bitwise &
100 function can_perform($bitmask, $productid = 0, $userinfo = null
)
104 // masks that aren't product-specific
105 static $inspecific = array(
117 if ($userinfo == null
)
119 $userinfo =& bugdar
::$userinfo;
122 $permissions =& bugdar
::$datastore['permission'];
124 if (!isset(bugdar
::$permissions["$bitmask"]))
126 trigger_error('Invalid bitmask "' . $bitmask . '" specified for can_perform() [includes/functions.php]', E_USER_WARNING
);
129 if (!$userinfo['permissions'])
131 $userinfo['permissions'] = FetchUserPermissions($userinfo);
134 if ($productid AND !in_array($bitmask, $inspecific))
136 $verdict = (isset($permissions["$userinfo[usergroupid]"]["$productid"]) ?
($permissions["$userinfo[usergroupid]"]["$productid"] & bugdar
::$permissions["$bitmask"]) : ($userinfo['permissions'] & bugdar
::$permissions["$bitmask"]));
138 foreach ($userinfo['groupids'] AS $group)
140 if (isset($permissions["$group"]["$productid"]))
142 $verdict |
= ($permissions["$group"]["$productid"] & bugdar
::$permissions["$bitmask"]);
145 BSApp
::debug("verdict* on can_perform($bitmask, $productid, $userinfo[userid]) = $verdict");
149 BSApp
::debug("verdict on can_perform($bitmask, $productid, $userinfo[userid]) = " . ($userinfo['permissions'] & bugdar
::$permissions["$bitmask"]));
150 return ($userinfo['permissions'] & bugdar
::$permissions["$bitmask"]);
154 * Runs through a given datastore item and creates a series of <select>
159 * @param string Datastore name
160 * @param string Array index for the label
161 * @param string Array index for the value
162 * @param mixed The selected value(s)
163 * @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
164 * @param bool Generate it using admin printers?
166 * @return string Unelss in admin mode, returns the constructed options
168 function construct_datastore_select($datastore, $labelname, $valuename, $selectedvalue = 0, $includeblank = false
, $adminmode = false
)
179 if ($includeblank === true
OR $includeblank !== false
)
181 $newval = ($inclueblank === true ?
'' : $includeblank);
184 $admin->list_item('', '', ((!$selectedvalue OR (is_array($selectedvalue) AND in_array($newval, $selectedvalue))) ? true
: false
));
188 $tpl = new BSTemplate('selectoption');
192 'selected' => (!$selectedvalue ||
(is_array($selectedvalue) && in_array($newval, $selectedvalue)))
194 $select .= $tpl->evaluate()->getTemplate();
198 foreach (bugdar
::$datastore["$datastore"] AS $item)
200 $label = $item["$labelname"];
201 $value = $item["$valuename"];
202 $selected = (($value == $selectedvalue OR (is_array($selectedvalue) AND in_array($value, $selectedvalue))) ? true
: false
);
206 $admin->list_item($label, $value, $selected);
210 $tpl = new BSTemplate('selectoption');
214 'selected' => $selected
216 $select .= $tpl->evaluate()->getTemplate();
226 // ################## Start construct_custom_fields ##################
227 function construct_custom_fields($bug = array(), $ignore21mask = false
, $nodefault = false
, $searchMode = false
)
231 if (!is_array($fields))
234 $fields_fetch = BSApp
::$db->query("
235 SELECT bugfield.*, MAX(permission.mask) AS mask
236 FROM " . TABLE_PREFIX
. "bugfield AS bugfield
237 LEFT JOIN " . TABLE_PREFIX
. "bugfieldpermission AS permission
238 ON (bugfield.fieldid = permission.fieldid)
239 WHERE (permission.mask = 2 OR permission.mask = 1)
240 AND permission.usergroupid IN (" . bugdar
::$userinfo['usergroupid'] . (sizeof(bugdar
::$userinfo['groupids']) != 0 ?
',' . implode(',', bugdar
::$userinfo['groupids']) : '') . ")
241 GROUP BY (bugfield.fieldid)
243 foreach ($fields_fetch as $field)
245 $fields["$field[fieldid]"] = $field;
249 $fieldbits = array();
251 foreach ($fields AS $field)
255 $field['defaultvalue'] = '';
258 if (!is_null($bug["custom$field[fieldid]"]))
260 BSApp
::debug("not null: $field[fieldid]");
261 $value = $bug["custom$field[fieldid]"];
265 $value = $field['defaultvalue'];
268 if ($ignore21mask AND $field['mask'] != 0)
273 if ($field['mask'] == 2)
275 switch ($field['type'])
278 $tpl = new BSTemplate('bugfield_input_text');
283 $tempfield = $tpl->evaluate()->getTemplate();
286 case 'input_checkbox':
287 $tpl = new BSTemplate('bugfield_input_checkbox');
290 'searchMode' => $searchMode,
291 'selected' => ($value ?
' checked="checked"' : '')
293 $tempfield = $tpl->evaluate()->getTemplate();
296 case 'select_single':
297 $selects = unserialize($field['selects']);
298 $value = trim($value);
300 $tpl = new BSTemplate('bugfield_select_single_option');
304 'selected' => ((!$field['usedefault'] && !trim($value)) ?
' selected="selected"' : '')
306 $options = $tpl->evaluate()->getTemplate();
308 foreach ($selects as $id => $select)
310 $tpl = new BSTemplate('bugfield_select_single_option');
313 'select' => stripslashes(trim($select)),
314 'selected' => (($select == $value ||
($field['usedefault'] && $id == 0)) ?
' selected="selected"' : '')
316 $options .= $tpl->evaluate()->getTemplate();
319 $tpl = new BSTemplate('bugfield_select_single');
322 'options' => $options
324 $tempfield = $tpl->evaluate()->getTemplate();
330 BSApp
::debug('mask 1 processing');
331 if (is_null($bug["custom$field[fieldid]"]))
333 BSApp
::debug("is null: $field[fieldid]");
334 if ($field['type'] == 'select_single')
336 if ($field['usedefault'])
338 $temp = unserialize($field['selects']);
339 $value = trim($temp[0]);
343 $value = $bug["custom$field[fieldid]"];
348 $value = $field['defaultvalue'];
353 $value = $bug["custom$field[fieldid]"];
356 if ($field['type'] == 'input_checkbox')
358 $value = ($value ?
'True' : 'False');
360 $field['value'] = $value;
362 $tpl = new BSTemplate('bugfield_static_text');
363 $tpl->vars
= array('field' => $field);
364 $tempfield = $tpl->evaluate()->getTemplate();
366 $fieldbits[] = $tempfield;
372 // ###################################################################
374 * This takes the bug API object and input data and then sanitizes, verifies,
375 * and processes the data for custom fields. If there are any errors,
376 * they are passed to the message reporter.
378 * @param object A BugAPI object
379 * @param object MessageReporter object
380 * @param bool If there are errors, add them to an errorbox format? If not, then display-on-encounter
381 * @param bool Search mode: don't change certain fields when they're 0 or empty
383 * @return mixed NULL if an ID is passed, string if bugid is NULL
385 function process_custom_fields(&$bugapi, &$msg, $errorbox = false
, $searchMode = false
)
389 $inputdata = &BSApp
::$input->in
;
392 $fields = BSApp
::$db->query("
393 SELECT bugfield.*, MAX(permission.mask) AS mask
394 FROM " . TABLE_PREFIX
. "bugfield AS bugfield
395 LEFT JOIN " . TABLE_PREFIX
. "bugfieldpermission AS permission
396 ON (bugfield.fieldid = permission.fieldid)
397 WHERE permission.mask = 2
398 AND permission.usergroupid IN (" . bugdar
::$userinfo['usergroupid'] . (sizeof(bugdar
::$userinfo['groupids']) != 0 ?
',' . implode(',', bugdar
::$userinfo['groupids']) : '') . ")
399 GROUP BY (bugfield.fieldid)
401 foreach ($fields as $field)
403 $fieldname = "custom$field[fieldid]";
405 if ($field['type'] == 'input_checkbox')
407 if ($searchMode AND intval($inputdata["$fieldname"]) == 0)
411 $bugapi->set($fieldname, intval($inputdata["$fieldname"]));
414 else if ($field['type'] == 'select_single')
416 $temp = unserialize($field['selects']);
417 $inputdata[$fieldname] = $temp[intval($inputdata["$fieldname"])] . ''; // make it a string so isset() doesn't catch
420 // field data wasn't passed, so skip it
421 if (!isset($inputdata["$fieldname"]))
426 if ($field['required'] AND empty($inputdata["$fieldname"]) AND !$searchMode)
428 $errorlist[] = sprintf(T('The field "%1$s" is a required.'), $field['name']);
432 if (!empty($field['regexmatch']))
434 if (!preg_match('#' . str_replace('#', '\#', $field['regexmatch']) . '#si', $inputdata["$fieldname"]))
436 $errorlist[] = sprintf(T('%1$s does not match the specified format'), $field['name']);
441 if (isset($inputdata["$fieldname"]))
443 if ($field['type'] == 'input_text')
445 if (empty($inputdata["$fieldname"]) AND $searchMode)
449 $bugapi->set($fieldname, $inputdata["$fieldname"]);
453 if (empty($inputdata["$fieldname"]))
457 $bugapi->set($fieldname, '');
462 $bugapi->set($fieldname, trim($inputdata["$fieldname"]));
471 foreach ($errorlist AS $err)
473 $msg->addError($err);
478 $msg->error($errorlist[0]);
483 // ####################### Start fetch_on_bits #######################
484 function fetch_on_bits($mask, $userinfo = null
)
488 if ($userinfo == null
)
490 $userinfo =& bugdar
::$userinfo;
495 $usergroupid = $userinfo['usergroupid'];
496 FetchUserPermissions($userinfo); // get the groups
497 $groups = $userinfo['groupids'];
498 $groups[] = $usergroupid;
500 // product-inspecific work
501 if (is_array(bugdar
::$datastore['product']))
503 foreach ($groups AS $groupid)
505 // we only need to do this so long as there's no onbits array because this isn't product specific
506 if (sizeof($onbits) == 0 AND bugdar
::$datastore['usergroup']["$groupid"]['permissions'] & bugdar
::$permissions["$mask"])
508 foreach (bugdar
::$datastore['product'] AS $id => $product)
510 $onbits["$id"] = $id;
516 // bits set explicitly by products
519 // product specific work
520 foreach ($groups AS $groupid)
522 if (is_array(bugdar
::$datastore['permission']["$groupid"]))
524 foreach (bugdar
::$datastore['permission']["$groupid"] AS $productid => $bit)
526 if ($bit & bugdar
::$permissions["$mask"])
528 $explicit["$productid"] = $productid;
529 $onbits["$productid"] = $productid;
533 // only unset if the bit was set in the first place by blanket and not product-specific permissions
534 // if it was set by product permissions then the highest level takes precedence
535 if ($onbits["$productid"] AND !isset($explicit["$productid"]))
537 unset($onbits["$productid"]);
544 // SQL queries would become very unhappy if we didn't do this
545 if (sizeof($onbits) < 1)
550 return implode(',', $onbits);
554 * Pre-parse hook for BSTemplate class. This merely substitutes help links
556 * @param string Template
559 function isso_pre_parse_hook($template)
561 $template = preg_replace('#\$help\[(.*)\]#', '<?php echo fetch_help_link("\1") ?>', $template);
566 * Returns the HTML used to generate a help link for a given topic
568 * @param string Topic name
571 function fetch_help_link($topic)
573 $tpl = new BSTemplate('help_link');
574 $tpl->vars
= array('topic' => $topic);
576 if (isset(bugdar
::$datastore['help']["$topic"]))
578 return $tpl->evaluate()->getTemplate();
582 if (BSApp
::get_debug())
584 return "[[INVALID TOPIC: $topic]]";
589 return $tpl->evaluate()->getTemplate();
594 // ###################################################################
596 * Returns a user array of information that is specific to all visiting
597 * users (guests). This can then be passed to any function that requires
602 * @return array User information array
604 function fetch_guest_user()
610 'groupids' => array(),
615 'permissions' => bugdar
::$datastore['usergroup'][1]['permissions'],
616 'displaytitle' => bugdar
::$datastore['usergroup'][1]['displaytitle'],
617 'timezone' => bugdar
::$options['defaulttimezone']
621 // ###################################################################
623 * Does an exhaustive permissions check on the bug. It checks for hidden
624 * bug status and ability to view hidden bugs. This normally was done
625 * at the top of each page, but it got so big, it was moved to a function.
629 * @param array Bug array
630 * @param array Alternate user array
632 * @return bool Does the user have permission
634 function check_bug_permissions($bug, $userinfo = null
)
637 if ($userinfo == null
)
639 $userinfo = bugdar
::$userinfo;
642 BSApp
::debug("checking permissions for $userinfo[userid] on bug $bug[bugid]");
644 BSApp
::debug('*** START VERBOSE CHECK ***');
646 BSApp
::debug('* !can_perform(canviewbugs, $bug[product], $userinfo) = ' . (int)(!can_perform('canviewbugs', $bug['product'], $userinfo)));
647 BSApp
::debug('* $bug[hidden] = ' . (int)$bug['hidden']);
648 BSApp
::debug('* $userinfo[userid] (' . $userinfo['userid'] . ') == $bug[userid] (' . $bug['userid'] . ') = ' . (int)($userinfo['userid'] == $bug['userid']));
649 BSApp
::debug('* can_perform(canviewownhidden, $bug[product], $userinfo) = ' . (int)(!!can_perform('canviewownhidden', $bug['product'], $userinfo)));
650 BSApp
::debug('* can_perform(canviewhidden, $bug[product], $userinfo) = ' . (int)(!!can_perform('canviewhidden', $bug['product'], $userinfo)));
651 BSApp
::debug('* !$bug[hidden] = ' . (int)(!$bug['hidden']));
653 BSApp
::debug('*** END PERMISSIONS CHECK ***');
657 !can_perform('canviewbugs', $bug['product'], $userinfo)
664 ($userinfo['userid'] == $bug['userid'] AND can_perform('canviewownhidden', $bug['product'], $userinfo))
666 can_perform('canviewhidden', $bug['product'], $userinfo)
674 BSApp
::debug('*** DONE WITH REAL CALLS ***');
678 BSApp
::debug('*** DONE WITH REAL CALLS ***');
683 // ###################################################################
685 * Takes an array of bug information and returns another array with
686 * information that is suitable for display as all the IDs have been
687 * replaced by their string equivalents
689 * @param array Unprocessed bug data
690 * @param string Color to display if the user has opted to not show status colours
692 * @param array Bug array with data fit for display
694 function ProcessBugDataForDisplay($bug, $color = '')
698 $bug['hiddendisplay'] = ($bug['hidden'] AND (can_perform('canviewhidden', $bug['product']) OR (can_perform('canviewownhidden') AND $bug['userid'] == bugdar
::$userinfo['userid'])));
700 $bug['bgcolor'] = (bugdar
::$userinfo['showcolors'] ? bugdar
::$datastore['status']["$bug[status]"]['color'] : $color);
701 $bug['product'] = bugdar
::$datastore['product']["$bug[product]"]['title'];
702 $bug['version'] = bugdar
::$datastore['version']["$bug[version]"]['version'];
703 $bug['component'] = bugdar
::$datastore['component']["$bug[component]"]['title'];
704 $bug['status'] = bugdar
::$datastore['status']["$bug[status]"]['status'];
705 $bug['resolution'] = bugdar
::$datastore['resolution']["$bug[resolution]"]['resolution'];
706 $bug['priority'] = bugdar
::$datastore['priority']["$bug[priority]"]['priority'];
707 $bug['severity'] = bugdar
::$datastore['severity']["$bug[severity]"]['severity'];
708 $bug['assignedto'] = ((empty($bug['assignedto']) OR !isset(bugdar
::$datastore['assignto']["$bug[assignedto]"])) ?
'' : construct_user_display(bugdar
::$datastore['assignto']["$bug[assignedto]"]));
710 $bug['lastposttime'] = ($bug['hiddendisplay'] ?
$bug['hiddenlastposttime'] : $bug['lastposttime']);
711 $bug['lastpost'] = ($bug['hiddendisplay'] ?
$bug['hiddenlastpostbyname'] : $bug['lastpostbyname']);
713 $bug['lastposttime'] = BSApp
::$date->format(bugdar
::$options['dateformat'], $bug['lastposttime']);
718 // ###################################################################
720 * Determines the correct permissions of the user. This is especially
721 * important for working with multiple-usergroup permission schemes.
722 * If a user is assigned to more than one usergroup, the highest level
723 * will always override (so a YES will always override a NO); this is
724 * because permissions are calculated with bitwise OR.
726 * @param array The user array with usergroups already exploded
728 * @return integer Permissions value
730 function FetchUserPermissions(&$user)
734 $perms = (int)bugdar
::$datastore['usergroup']["$user[usergroupid]"]['permissions'];
735 if (!is_array($user['groupids']))
737 $user['groupids'] = explode(',', bugdar
::$userinfo['groupids']);
739 $user['groupids'] = BSFunctions
::array_strip_empty($user['groupids']);
741 foreach ($user['groupids'] AS $group)
743 $perms |
= (int)bugdar
::$datastore['usergroup']["$group"]['permissions'];
749 // ###################################################################
751 * Fetches the path for an email template, given the name of the
752 * template and the locale to use
754 * @param string The template name
755 * @param string Language locale code
757 * @return string Template path
759 function FetchEmailPath($name, $locale)
761 return '../locale/' . $locale . '/emails/' . $name;
764 /*=====================================================================*\
765 || ###################################################################
768 || ###################################################################
769 \*=====================================================================*/