* @since Chamilo 1.8.7 * @package admin ============================================================================== */ /** * The function that retrieves all the possible settings for a certain config setting * @author Patrick Cool , Ghent University */ function get_settings_options($var) { $table_settings_options = Database :: get_main_table(TABLE_MAIN_SETTINGS_OPTIONS); $sql = "SELECT * FROM $table_settings_options WHERE variable='$var'"; $result = Database::query($sql); while ($row = Database::fetch_array($result)) { $temp_array = array ('value' => $row['value'], 'display_text' => $row['display_text']); $settings_options_array[] = $temp_array; } return $settings_options_array; } /** * This function allows easy activating and inactivating of plugins * @todo: a similar function needs to be written to activate or inactivate additional tools. * @author Patrick Cool , Ghent University */ function handle_plugins() { global $SettingsStored; $userplugins = array(); $table_settings_current = Database :: get_main_table(TABLE_MAIN_SETTINGS_CURRENT); if (isset($_POST['submit_plugins'])) { store_plugins(); // add event to system log $time = time(); $user_id = api_get_user_id(); $category = $_GET['category']; event_system(LOG_CONFIGURATION_SETTINGS_CHANGE, LOG_CONFIGURATION_SETTINGS_CATEGORY, $category, $time, $user_id); Display :: display_confirmation_message(get_lang('SettingsStored')); } //echo get_lang('AvailablePlugins')."
echo '
'; /* We scan the plugin directory. Each folder is a potential plugin. */ $pluginpath = api_get_path(SYS_PLUGIN_PATH); $handle = @opendir($pluginpath); while (false !== ($file = readdir($handle))) { if ($file <> '.' AND $file <> '..' AND is_dir(api_get_path(SYS_PLUGIN_PATH).$file)) { $possibleplugins[] = $file; } } @closedir($handle); /* for each of the possible plugin dirs we check if a file plugin.php (that contains all the needed information about this plugin) can be found in the dir. this plugin.php file looks like $plugin_info['title']='The title of the plugin'; // $plugin_info['comment']="Some comment about the plugin"; $plugin_info['location']=array("loginpage_menu", "campushomepage_menu","banner"); // the possible locations where the plugins can be used $plugin_info['version']='0.1 alpha'; // The version number of the plugin $plugin_info['author']='Patrick Cool'; // The author of the plugin */ echo '
'; echo "\n"; echo "\t\n"; echo "\t\t\n"; echo "\t\t\n"; echo "\t\t\n"; echo "\t\t\n"; echo "\t\t\n"; echo "\t\t\n"; echo "\t\t\n"; echo "\t\t\n"; echo "\t\t\n"; echo "\t\n"; /* We retrieve all the active plugins. */ //$sql = "SELECT * FROM $table_settings_current WHERE category='Plugins'"; //$result = Database::query($sql); $result = api_get_settings('Plugins'); //while ($row = Database::fetch_array($result)) foreach($result as $row) { $usedplugins[$row['variable']][] = $row['selected_value']; } /* We display all the possible plugins and the checkboxes */ foreach ($possibleplugins as $testplugin) { $plugin_info_file = api_get_path(SYS_PLUGIN_PATH).$testplugin."/plugin.php"; if (file_exists($plugin_info_file)) { $plugin_info = array(); include ($plugin_info_file); echo "\t\n"; echo "\t\t\n"; // column: LoginPageMainArea if(empty($usedplugins)) { $usedplugins = array(); } display_plugin_cell('loginpage_main', $plugin_info, $testplugin, $usedplugins); display_plugin_cell('loginpage_menu', $plugin_info, $testplugin, $usedplugins); display_plugin_cell('campushomepage_main', $plugin_info, $testplugin, $usedplugins); display_plugin_cell('campushomepage_menu', $plugin_info, $testplugin, $usedplugins); display_plugin_cell('mycourses_main', $plugin_info, $testplugin, $usedplugins); display_plugin_cell('mycourses_menu', $plugin_info, $testplugin, $usedplugins); display_plugin_cell('header', $plugin_info, $testplugin, $usedplugins); display_plugin_cell('footer', $plugin_info, $testplugin, $usedplugins); echo "\t\n"; } } echo '
\n"; echo get_lang('Plugin'); echo "\t\t\n"; echo get_lang('LoginPageMainArea'); echo "\t\t\n"; echo get_lang('LoginPageMenu'); echo "\t\t\n"; echo get_lang('CampusHomepageMainArea'); echo "\t\t\n"; echo get_lang('CampusHomepageMenu'); echo "\t\t\n"; echo get_lang('MyCoursesMainArea'); echo "\t\t\n"; echo get_lang('MyCoursesMenu'); echo "\t\t\n"; echo get_lang('Header'); echo "\t\t\n"; echo get_lang('Footer'); echo "\t\t
\n"; foreach ($plugin_info as $key => $value) { if ($key <> 'location') { if ($key == 'title') { $value = ''.$value.''; } echo get_lang(ucwords($key)).': '.$value.'
'; } } if (file_exists(api_get_path(SYS_PLUGIN_PATH).$testplugin.'/readme.txt')) { echo "readme.txt"; } echo "\t\t
'; echo '
'; echo '
'; echo '
'; } function display_plugin_cell($location, $plugin_info, $current_plugin, $active_plugins) { echo "\t\t\n"; if (in_array($location, $plugin_info['location'])) { if (isset($active_plugins[$location]) && is_array($active_plugins[$location]) && in_array($current_plugin, $active_plugins[$location])) { $checked = "checked"; } else { $checked = ''; } echo ''; } echo "\t\t\n"; } /** * This function allows the platform admin to choose the default stylesheet * @author Patrick Cool , Ghent University */ function handle_stylesheets() { global $_configuration; // Current style $currentstyle = api_get_setting('stylesheets'); $is_style_changeable=false; if ($_configuration['access_url']!=1) { $style_info = api_get_settings('stylesheets','',1,0); $url_info = api_get_access_url($_configuration['access_url']); if ($style_info[0]['access_url_changeable']==1 && $url_info['active']==1) { $is_style_changeable=true; echo ''; } } else { $is_style_changeable=true; echo ''; } $form = new FormValidator('stylesheet_upload','post','settings.php?category=stylesheets&showuploadform=true'); $form->addElement('text','name_stylesheet',get_lang('NameStylesheet'),array('size' => '40', 'maxlength' => '40')); $form->addRule('name_stylesheet', get_lang('ThisFieldIsRequired'), 'required'); $form->addElement('file', 'new_stylesheet', get_lang('UploadNewStylesheet')); $allowed_file_types = array ('css'); $form->addRule('new_stylesheet', get_lang('InvalidExtension').' ('.implode(',', $allowed_file_types).')', 'filetype', $allowed_file_types); $form->addRule('new_stylesheet', get_lang('ThisFieldIsRequired'), 'required'); $form->addElement('style_submit_button', 'stylesheet_upload', get_lang('Ok'), array('class'=>'save')); if( $form->validate() AND is_writable(api_get_path(SYS_CODE_PATH).'css/')) { $values = $form->exportValues(); $picture_element = & $form->getElement('new_stylesheet'); $picture = $picture_element->getValue(); upload_stylesheet($values, $picture); // add event to system log $time = time(); $user_id = api_get_user_id(); $category = $_GET['category']; event_system(LOG_CONFIGURATION_SETTINGS_CHANGE, LOG_CONFIGURATION_SETTINGS_CATEGORY, $category, $time, $user_id); Display::display_confirmation_message(get_lang('StylesheetAdded')); } else { if (!is_writable(api_get_path(SYS_CODE_PATH).'css/')) { Display::display_error_message(api_get_path(SYS_CODE_PATH).'css/'.get_lang('IsNotWritable')); } else { if ($_GET['showuploadform'] == 'true') { echo '
'; } else { echo ''; } } // Preview of the stylesheet echo '
'; echo '
'; if ($handle = @opendir(api_get_path(SYS_PATH).'main/css/')) { $counter=1; while (false !== ($style_dir = readdir($handle))) { if(substr($style_dir,0,1)=='.') //skip dirs starting with a '.' { continue; } $dirpath = api_get_path(SYS_PATH).'main/css/'.$style_dir; if (is_dir($dirpath)) { if ($style_dir != '.' && $style_dir != '..') { if ($currentstyle == $style_dir OR ($style_dir == 'dokeos_classic' AND !$currentstyle)) { $selected = 'checked="checked"'; } else { $selected = ''; } $show_name=get_lang(str_replace(' ','', ucwords(str_replace('_',' ', $style_dir))), ''); if ($is_style_changeable) { echo ""; echo ''.$show_name.''; } else echo ''.$show_name.''; //echo ''; echo "
\n"; $counter++; } } } @closedir($handle); } if ($is_style_changeable) { echo '
'; } } /** * creates the folder (if needed) and uploads the stylesheet in it * * @param array $values the values of the form * @param array $picture the values of the uploaded file * * @author Patrick Cool , Ghent University, Belgium * @version May 2008 * @since Dokeos 1.8.5 */ function upload_stylesheet($values,$picture) { // valid name for the stylesheet folder $style_name = api_preg_replace('/[^A-Za-z0-9]/', '', $values['name_stylesheet']); // create the folder if needed if (!is_dir(api_get_path(SYS_CODE_PATH).'css/'.$style_name.'/')) { mkdir(api_get_path(SYS_CODE_PATH).'css/'.$style_name.'/', api_get_permissions_for_new_directories()); } // move the file in the folder move_uploaded_file($picture['tmp_name'], api_get_path(SYS_CODE_PATH).'css/'.$style_name.'/'.$picture['name']); } /** * This function allows easy activating and inactivating of plugins * @todo: a similar function needs to be written to activate or inactivate additional tools. * @author Patrick Cool , Ghent University */ function store_plugins() { $table_settings_current = Database :: get_main_table(TABLE_MAIN_SETTINGS_CURRENT); global $_configuration; // Step 1 : we remove all the plugins //$sql = "DELETE FROM $table_settings_current WHERE category='Plugins'"; //Database::query($sql); $r = api_delete_category_settings('Plugins',$_configuration['access_url']); // step 2: looping through all the post values we only store these which are really a valid plugin location. foreach ($_POST as $form_name => $formvalue) { $form_name_elements = explode("-", $form_name); if (is_valid_plugin_location($form_name_elements[1])) { //$sql = "INSERT into $table_settings_current (variable,category,selected_value) VALUES ('".$form_name_elements['1']."','Plugins','".$form_name_elements['0']."')"; //Database::query($sql); api_add_setting($form_name_elements['0'],$form_name_elements['1'],$form_name_elements['0'],null,'Plugins',$form_name_elements['0'],null,null,null,$_configuration['access_url'],1); } } } /** * Check if the post information is really a valid plugin location. * @author Patrick Cool , Ghent University */ function is_valid_plugin_location($location) { $valid_locations=array('loginpage_main', 'loginpage_menu', 'campushomepage_main', 'campushomepage_menu', 'mycourses_main', 'mycourses_menu','header', 'footer'); if (in_array($location, $valid_locations)) { return true; } else { return false; } } /** * This function allows the platform admin to choose which should be the default stylesheet * @author Patrick Cool , Ghent University */ function store_stylesheets() { global $_configuration; // Database Table Definitions $table_settings_current = Database :: get_main_table(TABLE_MAIN_SETTINGS_CURRENT); // Insert the stylesheet $style = Database::escape_string($_POST['style']); if (is_style($style)) { /* $sql = 'UPDATE '.$table_settings_current.' SET selected_value = "'.$style.'" WHERE variable = "stylesheets" AND category = "stylesheets"'; Database::query($sql); */ api_set_setting('stylesheets',$style,null,'stylesheets',$_configuration['access_url']); } return true; } /** * This function checks if the given style is a recognize style that exists in the css directory as * a standalone directory. * @param string Style * @return bool True if this style is recognized, false otherwise */ function is_style($style) { $dir = api_get_path(SYS_PATH).'main/css/'; $dirs = scandir($dir); $style = str_replace(array('/','\\'),array('',''),$style); //avoid slashes or backslashes if (in_array($style,$dirs) && is_dir($dir.$style)) { return true; } return false; } /** * Search options * TODO: support for multiple site. aka $_configuration['access_url'] == 1 * @author Marco Villegas */ function handle_search() { global $SettingsStored, $_configuration; $search_enabled = api_get_setting('search_enabled'); $settings = api_get_settings('Search'); if ($search_enabled !== 'true' || count($settings) < 1) { Display::display_error_message(get_lang('SearchFeatureNotEnabledComment')); return; } require_once api_get_path(LIBRARY_PATH) . 'specific_fields_manager.lib.php'; $form = new FormValidator('search-options', 'post', api_get_self().'?category=Search'); $renderer = & $form->defaultRenderer(); $renderer->setHeaderTemplate('
{header}
'."\n"); $renderer->setElementTemplate('
{label}
'."\n".'
{element}
'."\n"); //search_show_unlinked_results $form->addElement('header', null, get_lang('SearchShowUnlinkedResultsTitle')); $form->addElement('label', null, get_lang('SearchShowUnlinkedResultsComment')); $values = get_settings_options('search_show_unlinked_results'); $group = array (); foreach ($values as $key => $value) { $element = & $form->createElement('radio', 'search_show_unlinked_results', '', get_lang($value['display_text']), $value['value']); $group[] = $element; } $form->addGroup($group, 'search_show_unlinked_results', get_lang('SearchShowUnlinkedResultsComment'), '
', false); $default_values['search_show_unlinked_results'] = api_get_setting('search_show_unlinked_results'); //search_prefilter_prefix $form->addElement('header', null, get_lang('SearchPrefilterPrefix')); $form->addElement('label', null, get_lang('SearchPrefilterPrefixComment')); $specific_fields = get_specific_field_list(); $sf_values = array(); foreach ($specific_fields as $sf) { $sf_values[$sf['code']] = $sf['name']; } $group = array (); $form->addElement('select', 'search_prefilter_prefix', get_lang('SearchPrefilterPrefix'), $sf_values, ''); $default_values['search_prefilter_prefix'] = api_get_setting('search_prefilter_prefix'); //$form->addRule('search_show_unlinked_results', get_lang('ThisFieldIsRequired'), 'required'); $form->addElement('style_submit_button', 'search-options-save', get_lang('Ok')); $form->setDefaults($default_values); if( $form->validate()) { $formvalues = $form->exportValues(); $r = api_set_settings_category('Search','false',$_configuration['access_url']); // Save the settings foreach ($formvalues as $key => $value) { $result = api_set_setting($key, $value, null, null); } Display :: display_confirmation_message($SettingsStored); } else { echo '
'; $form->display(); echo '
'; } } /** * wrapper for the templates * * @author Patrick Cool , Ghent University, Belgium * @version August 2008 * @since Dokeos 1.8.6 */ function handle_templates() { if ($_GET['action'] != 'add') { echo "\n
"; echo ''.Display::return_icon('template_add.gif', get_lang('AddTemplate')).get_lang('AddTemplate').''; echo "\n
"; } if ($_GET['action'] == 'add' OR ( $_GET['action'] == 'edit' AND is_numeric($_GET['id']))) { add_edit_template(); // add event to system log $time = time(); $user_id = api_get_user_id(); $category = $_GET['category']; event_system(LOG_CONFIGURATION_SETTINGS_CHANGE, LOG_CONFIGURATION_SETTINGS_CATEGORY, $category, $time, $user_id); } else { if ($_GET['action'] == 'delete' and is_numeric($_GET['id'])) { delete_template($_GET['id']); // add event to system log $time = time(); $user_id = api_get_user_id(); $category = $_GET['category']; event_system(LOG_CONFIGURATION_SETTINGS_CHANGE, LOG_CONFIGURATION_SETTINGS_CATEGORY, $category, $time, $user_id); } display_templates(); } } /** * Display a sortable table with all the templates that the platform administrator has defined. * * @author Patrick Cool , Ghent University, Belgium * @version August 2008 * @since Dokeos 1.8.6 */ function display_templates() { $table = new SortableTable('templates', 'get_number_of_templates', 'get_template_data',1); $table->set_additional_parameters(array('category'=>Security::remove_XSS($_GET['category']))); $table->set_header(0, get_lang('Image'), true, array ('style' => 'width:101px;')); $table->set_header(1, get_lang('Title')); $table->set_header(2, get_lang('Actions'), false, array ('style' => 'width:50px;')); $table->set_column_filter(2,'actions_filter'); $table->set_column_filter(0,'image_filter'); $table->display(); } /** * Get the number of templates that are defined by the platform admin. * * @return integer * * @author Patrick Cool , Ghent University, Belgium * @version August 2008 * @since Dokeos 1.8.6 */ function get_number_of_templates() { // Database table definition $table_system_template = Database :: get_main_table('system_template'); // The sql statement $sql = "SELECT COUNT(id) AS total FROM $table_system_template"; $result = Database::query($sql); $row = Database::fetch_array($result); // returning the number of templates return $row['total']; } /** * Get all the template data for the sortable table * * @param integer $from the start of the limit statement * @param integer $number_of_items the number of elements that have to be retrieved from the database * @param integer $column the column that is * @param string $direction the sorting direction (ASC or DESC� * @return array * * @author Patrick Cool , Ghent University, Belgium * @version August 2008 * @since Dokeos 1.8.6 */ function get_template_data($from, $number_of_items, $column, $direction) { // Database table definition $table_system_template = Database :: get_main_table('system_template'); // the sql statement $sql = "SELECT image as col0, title as col1, id as col2 FROM $table_system_template"; $sql .= " ORDER BY col$column $direction "; $sql .= " LIMIT $from,$number_of_items"; $result = Database::query($sql); while ($row = Database::fetch_array($result)) { $row['1'] = get_lang($row['1']); $return[] = $row; } // returning all the information for the sortable table return $return; } /** * display the edit and delete icons in the sortable table * * @param integer $id the id of the template * @return html code for the link to edit and delete the template * * @author Patrick Cool , Ghent University, Belgium * @version August 2008 * @since Dokeos 1.8.6 */ function actions_filter($id) { $return .= ''.Display::return_icon('edit.gif', get_lang('Edit')).''; $return .= ''.Display::return_icon('delete.gif', get_lang('Delete')).''; return $return; } /** * Display the image of the template in the sortable table * * @param string $image the image * @return html code for the image * * @author Patrick Cool , Ghent University, Belgium * @version August 2008 * @since Dokeos 1.8.6 */ function image_filter($image) { if (!empty($image)) { return ''.get_lang('TemplatePreview').''; } else { return ''.get_lang('NoTemplatePreview').''; } } /** * Add (or edit) a template. This function displays the form and also takes care of uploading the image and storing the information in the database * * @author Patrick Cool , Ghent University, Belgium * @version August 2008 * @since Dokeos 1.8.6 */ function add_edit_template() { // initiate the object $form = new FormValidator('template', 'post', 'settings.php?category=Templates&action='.Security::remove_XSS($_GET['action']).'&id='.Security::remove_XSS($_GET['id'])); // settting the form elements: the header if ($_GET['action'] == 'add') { $title = get_lang('AddTemplate'); } else { $title = get_lang('EditTemplate'); } $form->addElement('header', '', $title); // settting the form elements: the title of the template $form->add_textfield('title', get_lang('Title'), false); // settting the form elements: the content of the template (wysiwyg editor) $form->addElement('html_editor', 'template_text', get_lang('Text'), null, array('ToolbarSet' => 'AdminTemplates', 'Width' => '100%', 'Height' => '400')); // settting the form elements: the form to upload an image to be used with the template $form->addElement('file','template_image',get_lang('Image'),''); // settting the form elements: a little bit information about the template image $form->addElement('static', 'file_comment', '', get_lang('TemplateImageComment100x70')); // getting all the information of the template when editing a template if ($_GET['action'] == 'edit') { // Database table definition $table_system_template = Database :: get_main_table('system_template'); $sql = "SELECT * FROM $table_system_template WHERE id = '".Database::escape_string($_GET['id'])."'"; $result = Database::query($sql); $row = Database::fetch_array($result); $defaults['template_id'] = intval($_GET['id']); $defaults['template_text'] = $row['content']; //forcing a get_lang $defaults['title'] = get_lang($row['title']); // adding an extra field: a hidden field with the id of the template we are editing $form->addElement('hidden','template_id'); // adding an extra field: a preview of the image that is currently used if (!empty($row['image'])) { $form->addElement('static','template_image_preview', '', ''.get_lang('TemplatePreview').''); } else { $form->addElement('static','template_image_preview', '', ''.get_lang('NoTemplatePreview').''); } // setting the information of the template that we are editing $form->setDefaults($defaults); } // settting the form elements: the submit button $form->addElement('style_submit_button' , 'submit', get_lang('Ok') ,'class="save"'); // setting the rules: the required fields $form->addRule('title', '
'.get_lang('ThisFieldIsRequired'), 'required'); $form->addRule('template_text', '
'.get_lang('ThisFieldIsRequired'), 'required'); // if the form validates (complies to all rules) we save the information, else we display the form again (with error message if needed) if( $form->validate() ) { $check = Security::check_token('post'); if ($check) { // exporting the values $values = $form->exportValues(); // upload the file if (!empty($_FILES['template_image']['name'])) { include_once (api_get_path(LIBRARY_PATH).'fileUpload.lib.php'); $upload_ok = process_uploaded_file($_FILES['template_image']); if ($upload_ok) { // Try to add an extension to the file if it hasn't one $new_file_name = add_ext_on_mime(stripslashes($_FILES['template_image']['name']), $_FILES['template_image']['type']); // upload dir $upload_dir = api_get_path(SYS_PATH).'home/default_platform_document/template_thumb/'; // create dir if not exists if (!is_dir($upload_dir)) { mkdir($upload_dir, api_get_permissions_for_new_directories()); } // resize image to max default and upload require_once (api_get_path(LIBRARY_PATH).'image.lib.php'); $temp = new image($_FILES['template_image']['tmp_name']); $picture_infos=@getimagesize($_FILES['template_image']['tmp_name']); $max_width_for_picture = 100; if ($picture_infos[0]>$max_width_for_picture) { $thumbwidth = $max_width_for_picture; if (empty($thumbwidth) or $thumbwidth==0) { $thumbwidth=$max_width_for_picture; } $new_height = round(($thumbwidth/$picture_infos[0])*$picture_infos[1]); $temp->resize($thumbwidth,$new_height,0); } $type=$picture_infos[2]; switch (!empty($type)) { case 2 : $temp->send_image('JPG',$upload_dir.$new_file_name); break; case 3 : $temp->send_image('PNG',$upload_dir.$new_file_name); break; case 1 : $temp->send_image('GIF',$upload_dir.$new_file_name); break; } } } // store the information in the database (as insert or as update) $table_system_template = Database :: get_main_table('system_template'); if ($_GET['action'] == 'add') { $content_template = '{CSS}'.Database::escape_string($values['template_text']).''; $sql = "INSERT INTO $table_system_template (title, content, image) VALUES ('".Database::escape_string($values['title'])."','".$content_template."','".Database::escape_string($new_file_name)."')"; $result = Database::query($sql); // display a feedback message Display::display_confirmation_message(get_lang('TemplateAdded')); echo ''.Display::return_icon('template_add.gif', get_lang('AddTemplate')).get_lang('AddTemplate').''; } else { $content_template = '{CSS}'.Database::escape_string($values['template_text']).''; $sql = "UPDATE $table_system_template set title = '".Database::escape_string($values['title'])."', content = '".$content_template."'"; if (!empty($new_file_name)) { $sql .= ", image = '".Database::escape_string($new_file_name)."'"; } $sql .= " WHERE id='".Database::escape_string($_GET['id'])."'"; $result = Database::query($sql); // display a feedback message Display::display_confirmation_message(get_lang('TemplateEdited')); } } Security::clear_token(); display_templates(); } else { $token = Security::get_token(); $form->addElement('hidden','sec_token'); $form->setConstants(array('sec_token' => $token)); // display the form $form->display(); } } /** * Delete a template * * @param integer $id the id of the template that has to be deleted * * @author Patrick Cool , Ghent University, Belgium * @version August 2008 * @since Dokeos 1.8.6 */ function delete_template($id) { // first we remove the image $table_system_template = Database :: get_main_table('system_template'); $sql = "SELECT * FROM $table_system_template WHERE id = '".Database::escape_string($id)."'"; $result = Database::query($sql); $row = Database::fetch_array($result); if (!empty($row['image'])) { @unlink(api_get_path(SYS_PATH).'home/default_platform_document/template_thumb/'.$row['image']); } // now we remove it from the database $sql = "DELETE FROM $table_system_template WHERE id = '".Database::escape_string($id)."'"; $result = Database::query($sql); // display a feedback message Display::display_confirmation_message(get_lang('TemplateDeleted')); } /** * Returns the list of timezone identifiers used to populate the select * * @return array List of timezone identifiers * * @author Guillaume Viguier * @since Chamilo 1.8.7 */ function select_timezone_value() { return api_get_timezones(); }