/**
* Displays a form used to add/edit a routine
*
* @param string $mode If the editor will be used to edit a routine
* or add a new one: 'edit' or 'add'.
* @param string $operation If the editor was previously invoked with
* JS turned off, this will hold the name of
* the current operation
* @param array $routine Data for the routine returned by
* PMA_RTN_getDataFromRequest() or
* PMA_RTN_getDataFromName()
*
* @return string HTML code for the editor.
*/
function PMA_RTN_getEditorForm($mode, $operation, $routine)
{
global $db, $errors, $param_sqldataaccess, $param_opts_num;
// Escape special characters
$need_escape = array('item_original_name', 'item_name', 'item_returnlength', 'item_definition', 'item_definer', 'item_comment');
foreach ($need_escape as $key => $index) {
$routine[$index] = htmlentities($routine[$index], ENT_QUOTES, 'UTF-8');
}
for ($i = 0; $i < $routine['item_num_params']; $i++) {
$routine['item_param_name'][$i] = htmlentities($routine['item_param_name'][$i], ENT_QUOTES);
$routine['item_param_length'][$i] = htmlentities($routine['item_param_length'][$i], ENT_QUOTES);
}
// Handle some logic first
if ($operation == 'change') {
if ($routine['item_type'] == 'PROCEDURE') {
$routine['item_type'] = 'FUNCTION';
$routine['item_type_toggle'] = 'PROCEDURE';
} else {
$routine['item_type'] = 'PROCEDURE';
$routine['item_type_toggle'] = 'FUNCTION';
}
} else {
if ($operation == 'add' || $routine['item_num_params'] == 0 && $mode == 'add' && !$errors) {
$routine['item_param_dir'][] = '';
$routine['item_param_name'][] = '';
$routine['item_param_type'][] = '';
$routine['item_param_length'][] = '';
$routine['item_param_opts_num'][] = '';
$routine['item_param_opts_text'][] = '';
$routine['item_num_params']++;
} else {
if ($operation == 'remove') {
unset($routine['item_param_dir'][$routine['item_num_params'] - 1]);
unset($routine['item_param_name'][$routine['item_num_params'] - 1]);
unset($routine['item_param_type'][$routine['item_num_params'] - 1]);
unset($routine['item_param_length'][$routine['item_num_params'] - 1]);
unset($routine['item_param_opts_num'][$routine['item_num_params'] - 1]);
unset($routine['item_param_opts_text'][$routine['item_num_params'] - 1]);
$routine['item_num_params']--;
}
}
}
$disableRemoveParam = '';
if (!$routine['item_num_params']) {
$disableRemoveParam = " color: gray;' disabled='disabled";
}
$original_routine = '';
if ($mode == 'edit') {
$original_routine = "<input name='item_original_name' " . "type='hidden' " . "value='{$routine['item_original_name']}'/>\n" . "<input name='item_original_type' " . "type='hidden' " . "value='{$routine['item_original_type']}'/>\n";
}
$isfunction_class = '';
$isprocedure_class = '';
$isfunction_select = '';
$isprocedure_select = '';
if ($routine['item_type'] == 'PROCEDURE') {
$isfunction_class = ' hide';
$isprocedure_select = " selected='selected'";
} else {
$isprocedure_class = ' hide';
$isfunction_select = " selected='selected'";
}
// Create the output
$retval = "";
$retval .= "<!-- START " . mb_strtoupper($mode) . " ROUTINE FORM -->\n\n";
$retval .= "<form class='rte_form' action='db_routines.php' method='post'>\n";
$retval .= "<input name='{$mode}_item' type='hidden' value='1' />\n";
$retval .= $original_routine;
$retval .= PMA_URL_getHiddenInputs($db) . "\n";
$retval .= "<fieldset>\n";
$retval .= "<legend>" . __('Details') . "</legend>\n";
$retval .= "<table class='rte_table' style='width: 100%'>\n";
$retval .= "<tr>\n";
$retval .= " <td style='width: 20%;'>" . __('Routine name') . "</td>\n";
$retval .= " <td><input type='text' name='item_name' maxlength='64'\n";
$retval .= " value='{$routine['item_name']}' /></td>\n";
$retval .= "</tr>\n";
$retval .= "<tr>\n";
$retval .= " <td>" . __('Type') . "</td>\n";
$retval .= " <td>\n";
if ($GLOBALS['is_ajax_request']) {
$retval .= " <select name='item_type'>\n" . "<option value='PROCEDURE'{$isprocedure_select}>PROCEDURE</option>\n" . "<option value='FUNCTION'{$isfunction_select}>FUNCTION</option>\n" . "</select>\n";
} else {
$retval .= "<input name='item_type' type='hidden'" . " value='{$routine['item_type']}' />\n" . "<div class='floatleft' style='width: 49%; text-align: center;" . " font-weight: bold;'>\n" . $routine['item_type'] . "\n" . "</div>\n" . "<input style='width: 49%;' type='submit' name='routine_changetype'\n" . " value='" . sprintf(__('Change to %s'), $routine['item_type_toggle']) . "' />\n";
}
$retval .= " </td>\n";
$retval .= "</tr>\n";
$retval .= "<tr>\n";
$retval .= " <td>" . __('Parameters') . "</td>\n";
$retval .= " <td>\n";
// parameter handling start
$retval .= " <table class='routine_params_table'>\n";
$retval .= " <thead>\n";
$retval .= " <tr>\n";
$retval .= " <td></td>\n";
$retval .= " <th class='routine_direction_cell{$isprocedure_class}'>" . __('Direction') . "</th>\n";
$retval .= " <th>" . __('Name') . "</th>\n";
$retval .= " <th>" . __('Type') . "</th>\n";
$retval .= " <th>" . __('Length/Values') . "</th>\n";
$retval .= " <th colspan='2'>" . __('Options') . "</th>\n";
$retval .= " <th class='routine_param_remove hide'> </th>\n";
$retval .= " </tr>";
$retval .= " </thead>\n";
$retval .= " <tbody>\n";
for ($i = 0; $i < $routine['item_num_params']; $i++) {
// each parameter
$retval .= PMA_RTN_getParameterRow($routine, $i, $isprocedure_class);
}
$retval .= " </tbody>\n";
$retval .= " </table>";
$retval .= " </td>";
$retval .= "</tr>";
$retval .= "<tr>";
$retval .= " <td> </td>";
$retval .= " <td>";
$retval .= " <input style='width: 49%;' type='button'";
$retval .= " name='routine_addparameter'";
$retval .= " value='" . __('Add parameter') . "' />";
$retval .= " <input style='width: 49%;" . $disableRemoveParam . "'";
$retval .= " type='submit' ";
$retval .= " name='routine_removeparameter'";
$retval .= " value='" . __('Remove last parameter') . "' />";
$retval .= " </td>";
$retval .= "</tr>";
// parameter handling end
$retval .= "<tr class='routine_return_row" . $isfunction_class . "'>";
$retval .= " <td>" . __('Return type') . "</td>";
$retval .= " <td><select name='item_returntype'>";
$retval .= PMA\libraries\Util::getSupportedDatatypes(true, $routine['item_returntype']);
$retval .= " </select></td>";
$retval .= "</tr>";
$retval .= "<tr class='routine_return_row" . $isfunction_class . "'>";
$retval .= " <td>" . __('Return length/values') . "</td>";
$retval .= " <td><input type='text' name='item_returnlength'";
$retval .= " value='" . $routine['item_returnlength'] . "' /></td>";
$retval .= " <td class='hide no_len'>---</td>";
$retval .= "</tr>";
$retval .= "<tr class='routine_return_row" . $isfunction_class . "'>";
$retval .= " <td>" . __('Return options') . "</td>";
$retval .= " <td><div>";
$retval .= PMA_generateCharsetDropdownBox(PMA_CSDROPDOWN_CHARSET, "item_returnopts_text", null, $routine['item_returnopts_text']);
$retval .= " </div>";
$retval .= " <div><select name='item_returnopts_num'>";
$retval .= " <option value=''></option>";
foreach ($param_opts_num as $key => $value) {
$selected = "";
if (!empty($routine['item_returnopts_num']) && $routine['item_returnopts_num'] == $value) {
$selected = " selected='selected'";
}
$retval .= "<option" . $selected . ">" . $value . "</option>";
}
$retval .= " </select></div>";
$retval .= " <div class='hide no_opts'>---</div>";
$retval .= "</td>";
$retval .= "</tr>";
$retval .= "<tr>";
$retval .= " <td>" . __('Definition') . "</td>";
$retval .= " <td><textarea name='item_definition' rows='15' cols='40'>";
$retval .= $routine['item_definition'];
$retval .= "</textarea></td>";
$retval .= "</tr>";
$retval .= "<tr>";
$retval .= " <td>" . __('Is deterministic') . "</td>";
$retval .= " <td><input type='checkbox' name='item_isdeterministic'" . $routine['item_isdeterministic'] . " /></td>";
$retval .= "</tr>";
if (isset($_REQUEST['edit_item']) && !empty($_REQUEST['edit_item'])) {
$retval .= "<tr>";
$retval .= " <td>" . __('Adjust privileges');
$retval .= PMA\libraries\Util::showDocu('faq', 'faq6-39');
$retval .= "</td>";
if ($GLOBALS['proc_priv'] && $GLOBALS['is_reload_priv']) {
$retval .= " <td><input type='checkbox' " . "name='item_adjust_privileges' value='1' checked /></td>";
} else {
$retval .= " <td><input type='checkbox' " . "name='item_adjust_privileges' value='1' title='" . __("You do not have sufficient privileges to perform this " . "operation; Please refer to the documentation for more " . "details") . "' disabled/></td>";
}
$retval .= "</tr>";
}
$retval .= "<tr>";
$retval .= " <td>" . __('Definer') . "</td>";
$retval .= " <td><input type='text' name='item_definer'";
$retval .= " value='" . $routine['item_definer'] . "' /></td>";
$retval .= "</tr>";
$retval .= "<tr>";
$retval .= " <td>" . __('Security type') . "</td>";
$retval .= " <td><select name='item_securitytype'>";
$retval .= " <option value='DEFINER'" . $routine['item_securitytype_definer'] . ">DEFINER</option>";
$retval .= " <option value='INVOKER'" . $routine['item_securitytype_invoker'] . ">INVOKER</option>";
$retval .= " </select></td>";
$retval .= "</tr>";
$retval .= "<tr>";
$retval .= " <td>" . __('SQL data access') . "</td>";
$retval .= " <td><select name='item_sqldataaccess'>";
foreach ($param_sqldataaccess as $key => $value) {
$selected = "";
if ($routine['item_sqldataaccess'] == $value) {
$selected = " selected='selected'";
}
$retval .= " <option" . $selected . ">" . $value . "</option>";
}
$retval .= " </select></td>";
$retval .= "</tr>";
$retval .= "<tr>";
$retval .= " <td>" . __('Comment') . "</td>";
$retval .= " <td><input type='text' name='item_comment' maxlength='64'";
$retval .= " value='" . $routine['item_comment'] . "' /></td>";
$retval .= "</tr>";
$retval .= "</table>";
$retval .= "</fieldset>";
if ($GLOBALS['is_ajax_request']) {
$retval .= "<input type='hidden' name='editor_process_" . $mode . "'";
$retval .= " value='true' />";
$retval .= "<input type='hidden' name='ajax_request' value='true' />";
} else {
$retval .= "<fieldset class='tblFooters'>";
$retval .= " <input type='submit' name='editor_process_" . $mode . "'";
$retval .= " value='" . __('Go') . "' />";
$retval .= "</fieldset>";
}
$retval .= "</form>";
$retval .= "<!-- END " . mb_strtoupper($mode) . " ROUTINE FORM -->";
return $retval;
}
/**
* Displays a form used to add/edit a routine
*
* @param string $mode If the editor will be used edit a routine
* or add a new one: 'edit' or 'add'.
* @param string $operation If the editor was previously invoked with
* JS turned off, this will hold the name of
* the current operation
* @param array $routine Data for the routine returned by
* PMA_RTN_getDataFromRequest() or
* PMA_RTN_getDataFromName()
*
* @return string HTML code for the editor.
*/
function PMA_RTN_getEditorForm($mode, $operation, $routine)
{
global $db, $errors, $param_sqldataaccess, $param_opts_num;
// Escape special characters
$need_escape = array('item_original_name', 'item_name', 'item_returnlength', 'item_definition', 'item_definer', 'item_comment');
foreach ($need_escape as $key => $index) {
$routine[$index] = htmlentities($routine[$index], ENT_QUOTES);
}
for ($i = 0; $i < $routine['item_num_params']; $i++) {
$routine['item_param_name'][$i] = htmlentities($routine['item_param_name'][$i], ENT_QUOTES);
$routine['item_param_length'][$i] = htmlentities($routine['item_param_length'][$i], ENT_QUOTES);
}
// Handle some logic first
if ($operation == 'change') {
if ($routine['item_type'] == 'PROCEDURE') {
$routine['item_type'] = 'FUNCTION';
$routine['item_type_toggle'] = 'PROCEDURE';
} else {
$routine['item_type'] = 'PROCEDURE';
$routine['item_type_toggle'] = 'FUNCTION';
}
} else {
if ($operation == 'add' || $routine['item_num_params'] == 0 && $mode == 'add' && !$errors) {
$routine['item_param_dir'][] = '';
$routine['item_param_name'][] = '';
$routine['item_param_type'][] = '';
$routine['item_param_length'][] = '';
$routine['item_param_opts_num'][] = '';
$routine['item_param_opts_text'][] = '';
$routine['item_num_params']++;
} else {
if ($operation == 'remove') {
unset($routine['item_param_dir'][$routine['item_num_params'] - 1]);
unset($routine['item_param_name'][$routine['item_num_params'] - 1]);
unset($routine['item_param_type'][$routine['item_num_params'] - 1]);
unset($routine['item_param_length'][$routine['item_num_params'] - 1]);
unset($routine['item_param_opts_num'][$routine['item_num_params'] - 1]);
unset($routine['item_param_opts_text'][$routine['item_num_params'] - 1]);
$routine['item_num_params']--;
}
}
}
$disable_remove_parameter = '';
if (!$routine['item_num_params']) {
$disable_remove_parameter = " color: gray;' disabled='disabled";
}
$original_routine = '';
if ($mode == 'edit') {
$original_routine = "<input name='item_original_name' " . "type='hidden' " . "value='{$routine['item_original_name']}'/>\n" . "<input name='item_original_type' " . "type='hidden' " . "value='{$routine['item_original_type']}'/>\n";
}
$isfunction_class = '';
$isprocedure_class = '';
$isfunction_select = '';
$isprocedure_select = '';
if ($routine['item_type'] == 'PROCEDURE') {
$isfunction_class = ' hide';
$isprocedure_select = " selected='selected'";
} else {
$isprocedure_class = ' hide';
$isfunction_select = " selected='selected'";
}
// Create the output
$retval = "";
$retval .= "<!-- START " . strtoupper($mode) . " ROUTINE FORM -->\n\n";
$retval .= "<form class='rte_form' action='db_routines.php' method='post'>\n";
$retval .= "<input name='{$mode}_item' type='hidden' value='1' />\n";
$retval .= $original_routine;
$retval .= PMA_generate_common_hidden_inputs($db) . "\n";
$retval .= "<fieldset>\n";
$retval .= "<legend>" . __('Details') . "</legend>\n";
$retval .= "<table class='rte_table' style='width: 100%'>\n";
$retval .= "<tr>\n";
$retval .= " <td style='width: 20%;'>" . __('Routine name') . "</td>\n";
$retval .= " <td><input type='text' name='item_name' maxlength='64'\n";
$retval .= " value='{$routine['item_name']}' /></td>\n";
$retval .= "</tr>\n";
$retval .= "<tr>\n";
$retval .= " <td>" . __('Type') . "</td>\n";
$retval .= " <td>\n";
if ($GLOBALS['is_ajax_request']) {
$retval .= " <select name='item_type'>\n";
$retval .= " <option value='PROCEDURE'{$isprocedure_select}>PROCEDURE</option>\n";
$retval .= " <option value='FUNCTION'{$isfunction_select}>FUNCTION</option>\n";
$retval .= " </select>\n";
} else {
$retval .= " <input name='item_type' type='hidden' value='{$routine['item_type']}' />\n";
$retval .= " <div style='width: 49%; float: left; text-align: center; font-weight: bold;'>\n";
$retval .= " {$routine['item_type']}\n";
$retval .= " </div>\n";
$retval .= " <input style='width: 49%;' type='submit' name='routine_changetype'\n";
$retval .= " value='" . sprintf(__('Change to %s'), $routine['item_type_toggle']) . "' />\n";
}
$retval .= " </td>\n";
$retval .= "</tr>\n";
$retval .= "<tr>\n";
$retval .= " <td>" . __('Parameters') . "</td>\n";
$retval .= " <td>\n";
// parameter handling start
$retval .= " <table class='routine_params_table'>\n";
$retval .= " <tr>\n";
$retval .= " <th class='routine_direction_cell{$isprocedure_class}'>" . __('Direction') . "</th>\n";
$retval .= " <th>" . __('Name') . "</th>\n";
$retval .= " <th>" . __('Type') . "</th>\n";
$retval .= " <th>" . __('Length/Values') . "</th>\n";
$retval .= " <th colspan='2'>" . __('Options') . "</th>\n";
$retval .= " <th class='routine_param_remove hide'> </th>\n";
$retval .= " </tr>";
for ($i = 0; $i < $routine['item_num_params']; $i++) {
// each parameter
$retval .= PMA_RTN_getParameterRow($routine, $i, $isprocedure_class);
}
$retval .= " </table>\n";
$retval .= " </td>\n";
$retval .= "</tr>\n";
$retval .= "<tr>\n";
$retval .= " <td> </td>\n";
$retval .= " <td>\n";
$retval .= " <input style='width: 49%;' type='submit' \n";
$retval .= " name='routine_addparameter'\n";
$retval .= " value='" . __('Add parameter') . "' />\n";
$retval .= " <input style='width: 49%;{$disable_remove_parameter}'\n";
$retval .= " type='submit' \n";
$retval .= " name='routine_removeparameter'\n";
$retval .= " value='" . __('Remove last parameter') . "' />\n";
$retval .= " </td>\n";
$retval .= "</tr>\n";
// parameter handling end
$retval .= "<tr class='routine_return_row{$isfunction_class}'>\n";
$retval .= " <td>" . __('Return type') . "</td>\n";
$retval .= " <td><select name='item_returntype'>\n";
$retval .= PMA_CommonFunctions::getInstance()->getSupportedDatatypes(true, $routine['item_returntype']) . "\n";
$retval .= " </select></td>\n";
$retval .= "</tr>\n";
$retval .= "<tr class='routine_return_row{$isfunction_class}'>\n";
$retval .= " <td>" . __('Return length/values') . "</td>\n";
$retval .= " <td><input type='text' name='item_returnlength'\n";
$retval .= " value='{$routine['item_returnlength']}' /></td>\n";
$retval .= " <td class='hide no_len'>---</td>\n";
$retval .= "</tr>\n";
$retval .= "<tr class='routine_return_row{$isfunction_class}'>\n";
$retval .= " <td>" . __('Return options') . "</td>\n";
$retval .= " <td><div>\n";
$retval .= PMA_generateCharsetDropdownBox(PMA_CSDROPDOWN_CHARSET, "item_returnopts_text", null, $routine['item_returnopts_text']);
$retval .= "\n </div>\n";
$retval .= " <div><select name='item_returnopts_num'>\n";
$retval .= " <option value=''></option>";
foreach ($param_opts_num as $key => $value) {
$selected = "";
if (!empty($routine['item_returnopts_num']) && $routine['item_returnopts_num'] == $value) {
$selected = " selected='selected'";
}
$retval .= "<option{$selected}>{$value}</option>";
}
$retval .= "\n </select></div>\n";
$retval .= " <div class='hide no_opts'>---</div>\n";
$retval .= "</td>\n";
$retval .= "</tr>\n";
$retval .= "<tr>\n";
$retval .= " <td>" . __('Definition') . "</td>\n";
$retval .= " <td><textarea name='item_definition' rows='15' cols='40'>";
$retval .= $routine['item_definition'];
$retval .= "</textarea></td>\n";
$retval .= "</tr>\n";
$retval .= "<tr>\n";
$retval .= " <td>" . __('Is deterministic') . "</td>\n";
$retval .= " <td><input type='checkbox' name='item_isdeterministic'{$routine['item_isdeterministic']} /></td>\n";
$retval .= "</tr>\n";
$retval .= "<tr>\n";
$retval .= " <td>" . __('Definer') . "</td>\n";
$retval .= " <td><input type='text' name='item_definer'\n";
$retval .= " value='{$routine['item_definer']}' /></td>\n";
$retval .= "</tr>\n";
$retval .= "<tr>\n";
$retval .= " <td>" . __('Security type') . "</td>\n";
$retval .= " <td><select name='item_securitytype'>\n";
$retval .= " <option value='DEFINER'{$routine['item_securitytype_definer']}>DEFINER</option>\n";
$retval .= " <option value='INVOKER'{$routine['item_securitytype_invoker']}>INVOKER</option>\n";
$retval .= " </select></td>\n";
$retval .= "</tr>\n";
$retval .= "<tr>\n";
$retval .= " <td>" . __('SQL data access') . "</td>\n";
$retval .= " <td><select name='item_sqldataaccess'>\n";
foreach ($param_sqldataaccess as $key => $value) {
$selected = "";
if ($routine['item_sqldataaccess'] == $value) {
$selected = " selected='selected'";
}
$retval .= " <option{$selected}>{$value}</option>\n";
}
$retval .= " </select></td>\n";
$retval .= "</tr>\n";
$retval .= "<tr>\n";
$retval .= " <td>" . __('Comment') . "</td>\n";
$retval .= " <td><input type='text' name='item_comment' maxlength='64'\n";
$retval .= " value='{$routine['item_comment']}' /></td>\n";
$retval .= "</tr>\n";
$retval .= "</table>\n";
$retval .= "</fieldset>\n";
if ($GLOBALS['is_ajax_request']) {
$retval .= "<input type='hidden' name='editor_process_{$mode}'\n";
$retval .= " value='true' />\n";
$retval .= "<input type='hidden' name='ajax_request' value='true' />\n";
} else {
$retval .= "<fieldset class='tblFooters'>\n";
$retval .= " <input type='submit' name='editor_process_{$mode}'\n";
$retval .= " value='" . __('Go') . "' />\n";
$retval .= "</fieldset>\n";
}
$retval .= "</form>\n\n";
$retval .= "<!-- END " . strtoupper($mode) . " ROUTINE FORM -->\n\n";
return $retval;
}
/**
* @depends testgetParameterRow
* @dataProvider provider_row_ajax
*/
public function testgetParameterRow_ajax($data, $matcher)
{
$GLOBALS['is_ajax_request'] = false;
PMA_RTN_setGlobals();
$this->assertTag($matcher, PMA_RTN_getParameterRow($data), false);
}
/**
* Test for PMA_RTN_getParameterRow
*
* @param array $data Data for routine
* @param array $matcher Matcher
*
* @return void
*
* @depends testgetParameterRow
* @dataProvider providerRowAjax
*/
public function testgetParameterRowAjax($data, $matcher)
{
Response::getInstance()->setAjax(true);
PMA_RTN_setGlobals();
$this->assertContains(
$matcher,
PMA_RTN_getParameterRow($data)
);
Response::getInstance()->setAjax(false);
}
