';
+
+$table->display();
+
+// Displaying the footer
+Display::display_footer();
diff --git a/main/admin/specific_fields_add.php b/main/admin/specific_fields_add.php
new file mode 100644
index 0000000000..dd3f39072d
--- /dev/null
+++ b/main/admin/specific_fields_add.php
@@ -0,0 +1,101 @@
+ 'index.php', 'name' => get_lang('PlatformAdmin'));
+$interbreadcrumb[] = array ('url' => 'specific_fields.php', 'name' => get_lang('SpecificSearchFields'));
+if ($_GET['action']<>'edit')
+{
+ $tool_name = get_lang('AddSpecificSearchField');
+}
+else
+{
+ $tool_name = get_lang('EditSpecificSearchField');
+}
+// Create the form
+$form = new FormValidator('specific_fields_add');
+// Field variable name
+$form->addElement('hidden','field_id',(int)$_REQUEST['field_id']);
+$form->addElement('text','field_name',get_lang('FieldName'));
+$form->applyFilter('field_name','html_filter');
+$form->applyFilter('field_name','trim');
+$form->addRule('field_name', get_lang('ThisFieldIsRequired'), 'required');
+$form->addRule('fieldname', get_lang('OnlyLettersAndNumbersAllowed'), 'username');
+$form->addRule('fieldname', '', 'maxlength',20);
+
+// Set default values (only not empty when editing)
+$defaults = array();
+if (is_numeric($_REQUEST['field_id']))
+{
+ $form_information = get_specific_field_list(array( 'id' => (int)$_GET['field_id'] ));
+ $defaults['field_name'] = $form_information[0]['name'];
+}
+$form->setDefaults($defaults);
+// Submit button
+$form->addElement('submit', 'submit', get_lang('Add'));
+
+// Validate form
+if ($form->validate()) {
+ $field = $form->exportValues();
+ $field_name = $field['field_name'];
+ if (is_numeric($field['field_id']) && $field['field_id']<>0 && !empty($field['field_id']))
+ {
+ edit_specific_field($field['field_id'],$field['field_name']);
+ $message = get_lang('FieldEdited');
+ }
+ else
+ {
+ $field_id = add_specific_field($field_name);
+ $message = get_lang('FieldAdded');
+ }
+ header('Location: specific_fields.php?message='.$message);
+ //exit ();
+}
+
+// Display form
+Display::display_header($tool_name);
+
+$form->display();
+
+Display::display_footer();
\ No newline at end of file
diff --git a/main/img/ButtonGallOff.png b/main/img/ButtonGallOff.png
new file mode 100644
index 0000000000..1f82404c5a
Binary files /dev/null and b/main/img/ButtonGallOff.png differ
diff --git a/main/img/ButtonGallOn.png b/main/img/ButtonGallOn.png
new file mode 100644
index 0000000000..8788594558
Binary files /dev/null and b/main/img/ButtonGallOn.png differ
diff --git a/main/img/ButtonListOff.png b/main/img/ButtonListOff.png
new file mode 100644
index 0000000000..64a8b760ee
Binary files /dev/null and b/main/img/ButtonListOff.png differ
diff --git a/main/img/ButtonListOn.png b/main/img/ButtonListOn.png
new file mode 100644
index 0000000000..139c7acd4d
Binary files /dev/null and b/main/img/ButtonListOn.png differ
diff --git a/main/img/search-big-plus.gif b/main/img/search-big-plus.gif
new file mode 100644
index 0000000000..8465cc2602
Binary files /dev/null and b/main/img/search-big-plus.gif differ
diff --git a/main/img/search-lense.gif b/main/img/search-lense.gif
new file mode 100644
index 0000000000..f54b9604f4
Binary files /dev/null and b/main/img/search-lense.gif differ
diff --git a/main/img/thesaurus.gif b/main/img/thesaurus.gif
new file mode 100644
index 0000000000..08524ac386
Binary files /dev/null and b/main/img/thesaurus.gif differ
diff --git a/main/inc/lib/add_course.lib.inc.php b/main/inc/lib/add_course.lib.inc.php
index b77a7a3d97..a0646bc0d3 100644
--- a/main/inc/lib/add_course.lib.inc.php
+++ b/main/inc/lib/add_course.lib.inc.php
@@ -1980,6 +1980,10 @@ function fill_Db_course($courseDbName, $courseRepository, $language,$default_doc
}
}
+ if (api_get_setting('search_enabled')=='true') {
+ api_sql_query("INSERT INTO `" . $tbl_course_homepage . "` VALUES (NULL, '" . TOOL_SEARCH. "','search/','info.gif','".string2binary(api_get_setting('course_create_active_tools', 'enable_search')) . "','0','search.gif','NO','_self','authoring')", __FILE__, __LINE__);
+ }
+
// Smartblogs (Kevin Van Den Haute :: kevin@develop-it.be)
$sql = "INSERT INTO `" . $tbl_course_homepage . "` VALUES (NULL,'" . TOOL_BLOGS . "','blog/blog_admin.php','blog_admin.gif','" . string2binary(api_get_setting('course_create_active_tools', 'blogs')) . "','1','squaregrey.gif','NO','_self','admin')";
api_sql_query($sql, __FILE__, __LINE__);
diff --git a/main/inc/lib/database.lib.php b/main/inc/lib/database.lib.php
index 0601a89c27..0f0cc05e1a 100644
--- a/main/inc/lib/database.lib.php
+++ b/main/inc/lib/database.lib.php
@@ -1,4 +1,4 @@
- 1 && !select.visible() ) {
+ onChange(0, true);
+ }
+ }).bind("search", function() {
+ // TODO why not just specifying both arguments?
+ var fn = (arguments.length > 1) ? arguments[1] : null;
+ function findValueCallback(q, data) {
+ var result;
+ if( data && data.length ) {
+ for (var i=0; i < data.length; i++) {
+ if( data[i].result.toLowerCase() == q.toLowerCase() ) {
+ result = data[i];
+ break;
+ }
+ }
+ }
+ if( typeof fn == "function" ) fn(result);
+ else $input.trigger("result", result && [result.data, result.value]);
+ }
+ $.each(trimWords($input.val()), function(i, value) {
+ request(value, findValueCallback, findValueCallback);
+ });
+ }).bind("flushCache", function() {
+ cache.flush();
+ }).bind("setOptions", function() {
+ $.extend(options, arguments[1]);
+ // if we've updated the data, repopulate
+ if ( "data" in arguments[1] )
+ cache.populate();
+ }).bind("unautocomplete", function() {
+ select.unbind();
+ $input.unbind();
+ $(input.form).unbind(".autocomplete");
+ });
+
+
+ function selectCurrent() {
+ var selected = select.selected();
+ if( !selected )
+ return false;
+
+ var v = selected.result;
+ previousValue = v;
+
+ if ( options.multiple ) {
+ var words = trimWords($input.val());
+ if ( words.length > 1 ) {
+ v = words.slice(0, words.length - 1).join( options.multipleSeparator ) + options.multipleSeparator + v;
+ }
+ v += options.multipleSeparator;
+ }
+
+ $input.val(v);
+ hideResultsNow();
+ $input.trigger("result", [selected.data, selected.value]);
+ return true;
+ }
+
+ function onChange(crap, skipPrevCheck) {
+ if( lastKeyPressCode == KEY.DEL ) {
+ select.hide();
+ return;
+ }
+
+ var currentValue = $input.val();
+
+ if ( !skipPrevCheck && currentValue == previousValue )
+ return;
+
+ previousValue = currentValue;
+
+ currentValue = lastWord(currentValue);
+ if ( currentValue.length >= options.minChars) {
+ $input.addClass(options.loadingClass);
+ if (!options.matchCase)
+ currentValue = currentValue.toLowerCase();
+ request(currentValue, receiveData, hideResultsNow);
+ } else {
+ stopLoading();
+ select.hide();
+ }
+ };
+
+ function trimWords(value) {
+ if ( !value ) {
+ return [""];
+ }
+ var words = value.split( options.multipleSeparator );
+ var result = [];
+ $.each(words, function(i, value) {
+ if ( $.trim(value) )
+ result[i] = $.trim(value);
+ });
+ return result;
+ }
+
+ function lastWord(value) {
+ if ( !options.multiple )
+ return value;
+ var words = trimWords(value);
+ return words[words.length - 1];
+ }
+
+ // fills in the input box w/the first match (assumed to be the best match)
+ // q: the term entered
+ // sValue: the first matching result
+ function autoFill(q, sValue){
+ // autofill in the complete box w/the first match as long as the user hasn't entered in more data
+ // if the last user key pressed was backspace, don't autofill
+ if( options.autoFill && (lastWord($input.val()).toLowerCase() == q.toLowerCase()) && lastKeyPressCode != KEY.BACKSPACE ) {
+ // fill in the value (keep the case the user has typed)
+ $input.val($input.val() + sValue.substring(lastWord(previousValue).length));
+ // select the portion of the value not typed by the user (so the next character will erase)
+ $.Autocompleter.Selection(input, previousValue.length, previousValue.length + sValue.length);
+ }
+ };
+
+ function hideResults() {
+ clearTimeout(timeout);
+ timeout = setTimeout(hideResultsNow, 200);
+ };
+
+ function hideResultsNow() {
+ var wasVisible = select.visible();
+ select.hide();
+ clearTimeout(timeout);
+ stopLoading();
+ if (options.mustMatch) {
+ // call search and run callback
+ $input.search(
+ function (result){
+ // if no value found, clear the input box
+ if( !result ) {
+ if (options.multiple) {
+ var words = trimWords($input.val()).slice(0, -1);
+ $input.val( words.join(options.multipleSeparator) + (words.length ? options.multipleSeparator : "") );
+ }
+ else
+ $input.val( "" );
+ }
+ }
+ );
+ }
+ if (wasVisible)
+ // position cursor at end of input field
+ $.Autocompleter.Selection(input, input.value.length, input.value.length);
+ };
+
+ function receiveData(q, data) {
+ if ( data && data.length && hasFocus ) {
+ stopLoading();
+ select.display(data, q);
+ autoFill(q, data[0].value);
+ select.show();
+ } else {
+ hideResultsNow();
+ }
+ };
+
+ function request(term, success, failure) {
+ if (!options.matchCase)
+ term = term.toLowerCase();
+ var data = cache.load(term);
+ // recieve the cached data
+ if (data && data.length) {
+ success(term, data);
+ // if an AJAX url has been supplied, try loading the data now
+ } else if( (typeof options.url == "string") && (options.url.length > 0) ){
+
+ var extraParams = {
+ timestamp: +new Date()
+ };
+ $.each(options.extraParams, function(key, param) {
+ extraParams[key] = typeof param == "function" ? param() : param;
+ });
+
+ $.ajax({
+ // try to leverage ajaxQueue plugin to abort previous requests
+ mode: "abort",
+ // limit abortion to this input
+ port: "autocomplete" + input.name,
+ dataType: options.dataType,
+ url: options.url,
+ data: $.extend({
+ q: lastWord(term),
+ limit: options.max
+ }, extraParams),
+ success: function(data) {
+ var parsed = options.parse && options.parse(data) || parse(data);
+ cache.add(term, parsed);
+ success(term, parsed);
+ }
+ });
+ } else {
+ // if we have a failure, we need to empty the list -- this prevents the the [TAB] key from selecting the last successful match
+ select.emptyList();
+ failure(term);
+ }
+ };
+
+ function parse(data) {
+ var parsed = [];
+ var rows = data.split("\n");
+ for (var i=0; i < rows.length; i++) {
+ var row = $.trim(rows[i]);
+ if (row) {
+ row = row.split("|");
+ parsed[parsed.length] = {
+ data: row,
+ value: row[0],
+ result: options.formatResult && options.formatResult(row, row[0]) || row[0]
+ };
+ }
+ }
+ return parsed;
+ };
+
+ function stopLoading() {
+ $input.removeClass(options.loadingClass);
+ };
+
+};
+
+$.Autocompleter.defaults = {
+ inputClass: "ac_input",
+ resultsClass: "ac_results",
+ loadingClass: "ac_loading",
+ minChars: 1,
+ delay: 400,
+ matchCase: false,
+ matchSubset: true,
+ matchContains: false,
+ cacheLength: 10,
+ max: 100,
+ mustMatch: false,
+ extraParams: {},
+ selectFirst: true,
+ formatItem: function(row) { return row[0]; },
+ formatMatch: null,
+ autoFill: false,
+ width: 0,
+ multiple: false,
+ multipleSeparator: ", ",
+ highlight: function(value, term) {
+ return value.replace(new RegExp("(?![^&;]+;)(?!<[^<>]*)(" + term.replace(/([\^\$\(\)\[\]\{\}\*\.\+\?\|\\])/gi, "\\$1") + ")(?![^<>]*>)(?![^&;]+;)", "gi"), "$1");
+ },
+ scroll: true,
+ scrollHeight: 180
+};
+
+$.Autocompleter.Cache = function(options) {
+
+ var data = {};
+ var length = 0;
+
+ function matchSubset(s, sub) {
+ if (!options.matchCase)
+ s = s.toLowerCase();
+ var i = s.indexOf(sub);
+ if (i == -1) return false;
+ return i == 0 || options.matchContains;
+ };
+
+ function add(q, value) {
+ if (length > options.cacheLength){
+ flush();
+ }
+ if (!data[q]){
+ length++;
+ }
+ data[q] = value;
+ }
+
+ function populate(){
+ if( !options.data ) return false;
+ // track the matches
+ var stMatchSets = {},
+ nullData = 0;
+
+ // no url was specified, we need to adjust the cache length to make sure it fits the local data store
+ if( !options.url ) options.cacheLength = 1;
+
+ // track all options for minChars = 0
+ stMatchSets[""] = [];
+
+ // loop through the array and create a lookup structure
+ for ( var i = 0, ol = options.data.length; i < ol; i++ ) {
+ var rawValue = options.data[i];
+ // if rawValue is a string, make an array otherwise just reference the array
+ rawValue = (typeof rawValue == "string") ? [rawValue] : rawValue;
+
+ var value = options.formatMatch(rawValue, i+1, options.data.length);
+ if ( value === false )
+ continue;
+
+ var firstChar = value.charAt(0).toLowerCase();
+ // if no lookup array for this character exists, look it up now
+ if( !stMatchSets[firstChar] )
+ stMatchSets[firstChar] = [];
+
+ // if the match is a string
+ var row = {
+ value: value,
+ data: rawValue,
+ result: options.formatResult && options.formatResult(rawValue) || value
+ };
+
+ // push the current match into the set list
+ stMatchSets[firstChar].push(row);
+
+ // keep track of minChars zero items
+ if ( nullData++ < options.max ) {
+ stMatchSets[""].push(row);
+ }
+ };
+
+ // add the data items to the cache
+ $.each(stMatchSets, function(i, value) {
+ // increase the cache size
+ options.cacheLength++;
+ // add to the cache
+ add(i, value);
+ });
+ }
+
+ // populate any existing data
+ setTimeout(populate, 25);
+
+ function flush(){
+ data = {};
+ length = 0;
+ }
+
+ return {
+ flush: flush,
+ add: add,
+ populate: populate,
+ load: function(q) {
+ if (!options.cacheLength || !length)
+ return null;
+ /*
+ * if dealing w/local data and matchContains than we must make sure
+ * to loop through all the data collections looking for matches
+ */
+ if( !options.url && options.matchContains ){
+ // track all matches
+ var csub = [];
+ // loop through all the data grids for matches
+ for( var k in data ){
+ // don't search through the stMatchSets[""] (minChars: 0) cache
+ // this prevents duplicates
+ if( k.length > 0 ){
+ var c = data[k];
+ $.each(c, function(i, x) {
+ // if we've got a match, add it to the array
+ if (matchSubset(x.value, q)) {
+ csub.push(x);
+ }
+ });
+ }
+ }
+ return csub;
+ } else
+ // if the exact item exists, use it
+ if (data[q]){
+ return data[q];
+ } else
+ if (options.matchSubset) {
+ for (var i = q.length - 1; i >= options.minChars; i--) {
+ var c = data[q.substr(0, i)];
+ if (c) {
+ var csub = [];
+ $.each(c, function(i, x) {
+ if (matchSubset(x.value, q)) {
+ csub[csub.length] = x;
+ }
+ });
+ return csub;
+ }
+ }
+ }
+ return null;
+ }
+ };
+};
+
+$.Autocompleter.Select = function (options, input, select, config) {
+ var CLASSES = {
+ ACTIVE: "ac_over"
+ };
+
+ var listItems,
+ active = -1,
+ data,
+ term = "",
+ needsInit = true,
+ element,
+ list;
+
+ // Create results
+ function init() {
+ if (!needsInit)
+ return;
+ element = $("")
+ .hide()
+ .addClass(options.resultsClass)
+ .css("position", "absolute")
+ .appendTo(document.body);
+
+ list = $("
").appendTo(element).mouseover( function(event) {
+ if(target(event).nodeName && target(event).nodeName.toUpperCase() == 'LI') {
+ active = $("li", list).removeClass(CLASSES.ACTIVE).index(target(event));
+ $(target(event)).addClass(CLASSES.ACTIVE);
+ }
+ }).click(function(event) {
+ $(target(event)).addClass(CLASSES.ACTIVE);
+ select();
+ // TODO provide option to avoid setting focus again after selection? useful for cleanup-on-focus
+ input.focus();
+ return false;
+ }).mousedown(function() {
+ config.mouseDownOnSelect = true;
+ }).mouseup(function() {
+ config.mouseDownOnSelect = false;
+ });
+
+ if( options.width > 0 )
+ element.css("width", options.width);
+
+ needsInit = false;
+ }
+
+ function target(event) {
+ var element = event.target;
+ while(element && element.tagName != "LI")
+ element = element.parentNode;
+ // more fun with IE, sometimes event.target is empty, just ignore it then
+ if(!element)
+ return [];
+ return element;
+ }
+
+ function moveSelect(step) {
+ listItems.slice(active, active + 1).removeClass(CLASSES.ACTIVE);
+ movePosition(step);
+ var activeItem = listItems.slice(active, active + 1).addClass(CLASSES.ACTIVE);
+ if(options.scroll) {
+ var offset = 0;
+ listItems.slice(0, active).each(function() {
+ offset += this.offsetHeight;
+ });
+ if((offset + activeItem[0].offsetHeight - list.scrollTop()) > list[0].clientHeight) {
+ list.scrollTop(offset + activeItem[0].offsetHeight - list.innerHeight());
+ } else if(offset < list.scrollTop()) {
+ list.scrollTop(offset);
+ }
+ }
+ };
+
+ function movePosition(step) {
+ active += step;
+ if (active < 0) {
+ active = listItems.size() - 1;
+ } else if (active >= listItems.size()) {
+ active = 0;
+ }
+ }
+
+ function limitNumberOfItems(available) {
+ return options.max && options.max < available
+ ? options.max
+ : available;
+ }
+
+ function fillList() {
+ list.empty();
+ var max = limitNumberOfItems(data.length);
+ for (var i=0; i < max; i++) {
+ if (!data[i])
+ continue;
+ var formatted = options.formatItem(data[i].data, i+1, max, data[i].value, term);
+ if ( formatted === false )
+ continue;
+ var li = $("").html( options.highlight(formatted, term) ).addClass(i%2 == 0 ? "ac_even" : "ac_odd").appendTo(list)[0];
+ $.data(li, "ac_data", data[i]);
+ }
+ listItems = list.find("li");
+ if ( options.selectFirst ) {
+ listItems.slice(0, 1).addClass(CLASSES.ACTIVE);
+ active = 0;
+ }
+ // apply bgiframe if available
+ if ( $.fn.bgiframe )
+ list.bgiframe();
+ }
+
+ return {
+ display: function(d, q) {
+ init();
+ data = d;
+ term = q;
+ fillList();
+ },
+ next: function() {
+ moveSelect(1);
+ },
+ prev: function() {
+ moveSelect(-1);
+ },
+ pageUp: function() {
+ if (active != 0 && active - 8 < 0) {
+ moveSelect( -active );
+ } else {
+ moveSelect(-8);
+ }
+ },
+ pageDown: function() {
+ if (active != listItems.size() - 1 && active + 8 > listItems.size()) {
+ moveSelect( listItems.size() - 1 - active );
+ } else {
+ moveSelect(8);
+ }
+ },
+ hide: function() {
+ element && element.hide();
+ listItems && listItems.removeClass(CLASSES.ACTIVE);
+ active = -1;
+ },
+ visible : function() {
+ return element && element.is(":visible");
+ },
+ current: function() {
+ return this.visible() && (listItems.filter("." + CLASSES.ACTIVE)[0] || options.selectFirst && listItems[0]);
+ },
+ show: function() {
+ var offset = $(input).offset();
+ element.css({
+ width: typeof options.width == "string" || options.width > 0 ? options.width : $(input).width(),
+ top: offset.top + input.offsetHeight,
+ left: offset.left
+ }).show();
+ if(options.scroll) {
+ list.scrollTop(0);
+ list.css({
+ maxHeight: options.scrollHeight,
+ overflow: 'auto'
+ });
+
+ if($.browser.msie && typeof document.body.style.maxHeight === "undefined") {
+ var listHeight = 0;
+ listItems.each(function() {
+ listHeight += this.offsetHeight;
+ });
+ var scrollbarsVisible = listHeight > options.scrollHeight;
+ list.css('height', scrollbarsVisible ? options.scrollHeight : listHeight );
+ if (!scrollbarsVisible) {
+ // IE doesn't recalculate width when scrollbar disappears
+ listItems.width( list.width() - parseInt(listItems.css("padding-left")) - parseInt(listItems.css("padding-right")) );
+ }
+ }
+
+ }
+ },
+ selected: function() {
+ var selected = listItems && listItems.filter("." + CLASSES.ACTIVE).removeClass(CLASSES.ACTIVE);
+ return selected && selected.length && $.data(selected[0], "ac_data");
+ },
+ emptyList: function (){
+ list && list.empty();
+ },
+ unbind: function() {
+ element && element.remove();
+ }
+ };
+};
+
+$.Autocompleter.Selection = function(field, start, end) {
+ if( field.createTextRange ){
+ var selRange = field.createTextRange();
+ selRange.collapse(true);
+ selRange.moveStart("character", start);
+ selRange.moveEnd("character", end);
+ selRange.select();
+ } else if( field.setSelectionRange ){
+ field.setSelectionRange(start, end);
+ } else {
+ if( field.selectionStart ){
+ field.selectionStart = start;
+ field.selectionEnd = end;
+ }
+ }
+ field.focus();
+};
+
+})(jQuery);
\ No newline at end of file
diff --git a/main/inc/lib/main_api.lib.php b/main/inc/lib/main_api.lib.php
index 97abf8ec04..3d402b83f6 100644
--- a/main/inc/lib/main_api.lib.php
+++ b/main/inc/lib/main_api.lib.php
@@ -109,6 +109,7 @@ define('TOOL_HOTPOTATOES', 'hotpotatoes');
define('TOOL_CALENDAR_EVENT', 'calendar_event');
define('TOOL_LINK', 'link');
define('TOOL_COURSE_DESCRIPTION', 'course_description');
+define('TOOL_SEARCH', 'search');
define('TOOL_LEARNPATH', 'learnpath');
define('TOOL_ANNOUNCEMENT', 'announcement');
define('TOOL_FORUM', 'forum');
diff --git a/main/inc/lib/search/DokeosIndexer.class.php b/main/inc/lib/search/DokeosIndexer.class.php
index f2ecd80352..65a8db72bb 100644
--- a/main/inc/lib/search/DokeosIndexer.class.php
+++ b/main/inc/lib/search/DokeosIndexer.class.php
@@ -1,9 +1,87 @@
get_terms_on_db($prefix, $course_code, $tool_id, $ref_id_high_level);
+
+ // don't do anything if no change, verify only at DB, not the search engine
+ if ( (count(array_diff($terms, $stored_terms))==0) && (count(array_diff($stored_terms, $terms))==0) )
+ return FALSE;
+
+ require_once(api_get_path(LIBRARY_PATH).'search/xapian/XapianQuery.php');
+
+ // compare terms
+ $doc = $this->get_document($search_did);
+ $xapian_terms = xapian_get_doc_terms($doc, $prefix);
+ $xterms = array();
+ foreach ($xapian_terms as $xapian_term) $xterms[] = substr($xapian_term['name'],1);
+
+ $dterms = $terms;
+
+ $missing_terms = array_diff($dterms, $xterms);
+ $deprecated_terms = array_diff($xterms, $dterms);
+
+ // save it to search engine
+ foreach ($missing_terms as $term)
+ {
+ $this->add_term_to_doc($prefix. $term, $doc);
+ }
+ foreach ($deprecated_terms as $term)
+ {
+ $this->remove_term_from_doc($prefix.$term, $doc);
+ }
+
+ // don't do anything if no change
+ if ( (count($missing_terms) > 0) || (count($deprecated_terms) > 0)) {
+ $this->replace_document($doc, (int)$search_did);
+ }
+
+ return TRUE;
+ }
+
+ /**
+ * Get the terms stored at database
+ * @return array Array of terms
+ */
+ function get_terms_on_db($prefix, $course_code, $tool_id, $ref_id) {
+ require_once api_get_path(LIBRARY_PATH) . 'specific_fields_manager.lib.php';
+ $terms = get_specific_field_values_list_by_prefix($prefix, $course_code, $tool_id, $ref_id);
+ $prefix_terms = array();
+ foreach($terms as $term)
+ {
+ $prefix_terms[] = $term['value'];
+ }
+ return $prefix_terms;
+ }
+
}
-?>
\ No newline at end of file
+
+if (!function_exists('trim_value')) {
+ function trim_value(&$value) {
+ $value = trim($value);
+ }
+}
+
+?>
diff --git a/main/inc/lib/search/DokeosQuery.php b/main/inc/lib/search/DokeosQuery.php
index c80077fa95..ad8effca67 100644
--- a/main/inc/lib/search/DokeosQuery.php
+++ b/main/inc/lib/search/DokeosQuery.php
@@ -7,19 +7,34 @@ require 'xapian/XapianQuery.php';
/**
* Wrapper for queries
- *
+ *
* @param string $query_string The search string
* @param int $offset Offset to the first item to retrieve. Optional
* @param int lenght Number of items to retrieve. Optional
+ * @param array extra Extra queries to join with. Optional
* @return array
*/
-function dokeos_query_query($query_string, $offset=0, $length=10) {
- return xapian_query($query_string, NULL, $offset, $length);
+function dokeos_query_query($query_string, $offset=0, $length=10, $extra=NULL) {
+ list($count, $results) = xapian_query($query_string, NULL, $offset, $length, $extra);
+ return dokeos_preprocess_results($results);
+}
+
+function dokeos_query_simple_query($query_string, $offset=0, $length=10, $extra=NULL) {
+ return xapian_query($query_string, NULL, $offset, $length, $extra);
+}
+
+/**
+ * Wrapper for getting boolean queries
+ *
+ * @param string $query_string The term string
+ */
+function dokeos_get_boolean_query($term) {
+ return xapian_get_boolean_query($term);
}
/**
* Wrapper for getting tags
- *
+ *
* @param int $count Number of terms to retrieve. Optional.
* @return array
*/
@@ -29,11 +44,48 @@ function dokeos_query_get_tags($count=100) {
/**
* Wrapper for getting specific document tags
- *
+ *
* @param mixed Document entry, with apropiate class
* @return array
*/
function dokeos_query_tags_for_doc($doc) {
return xapian_get_doc_terms($doc);
}
-?>
\ No newline at end of file
+
+/**
+ * Preprocess all results depending on the toolid
+ */
+function dokeos_preprocess_results($results) {
+ // group by toolid
+ $results_by_tool = array();
+ foreach ($results as $key => $row) {
+ $results_by_tool[$row['toolid']][] = $row;
+ }
+
+ $processed_results = array();
+ foreach ($results_by_tool as $toolid => $rows) {
+ $tool_processor_class = $toolid .'_processor';
+ $tool_processor_path = api_get_path(LIBRARY_PATH) .'search/tool_processors/'. $tool_processor_class .'.class.php';
+ if (file_exists($tool_processor_path)) {
+ require_once($tool_processor_path);
+ $tool_processor = new $tool_processor_class($rows);
+ $processed_results = $tool_processor->process();
+ }
+ }
+
+ return array(count($processed_results), $processed_results);
+}
+
+/**
+ * Wrapper for join xapian queries
+ *
+ * @param XapianQuery|array $query1
+ * @param XapianQuery|array $query2
+ * @param string $op
+ * @return XapianQuery query joined
+ */
+function dokeos_join_queries($query1, $query2=NULL, $op='or') {
+ return xapian_join_queries($query1, $query2, $op);
+}
+
+?>
diff --git a/main/inc/lib/search/IndexableChunk.class.php b/main/inc/lib/search/IndexableChunk.class.php
index c49a4cceaf..49aed91713 100644
--- a/main/inc/lib/search/IndexableChunk.class.php
+++ b/main/inc/lib/search/IndexableChunk.class.php
@@ -1,15 +1,21 @@
string <- course id from course table on main db
+ * 'SE_TOOL_ID' => string <- tool id from mainapi lib constants
+ * 'SE_DATA' => mixed <- extra information, depends on SE_TOOL_ID
+ * 'SE_USER' => id <- user id from user table in main db
+ * )
+ */
+ public $xapian_data;
/**
* array(
@@ -28,83 +44,70 @@ abstract class _IndexableChunk
*/
public $terms;
- /**
- * Add a value to the indexed item
- * @param string Key
- * @param string Value
- * @return void
- */
+ /**
+ * Add a value to the indexed item
+ * @param string Key
+ * @param string Value
+ * @return void
+ */
function addValue($key, $value) {
$this->data[$key] = $value;
}
- /**
+ /**
* Add a term (like xapian definition)
- * @param string Term
+ * @param string Term
* @param string Flag (one character)
*/
- function addTerm($term, $flag) {
+ public function addTerm($term, $flag) {
+ global $charset;
if (strlen($flag) == 1) {
- $this->terms[] = array('name' => $term, 'flag' => $flag);
+ $this->terms[] = array('name' => mb_convert_encoding(stripslashes($term),'UTF-8',$charset), 'flag' => $flag);
}
}
- /**
- * Get the ID from an indexed item. In case data are in an array, get the second item of the 'ids' element of the array
- * @return integer ID
- */
- function getId() {
- $id = -1;
-
- if (is_array($this->data)) {
- $ids = explode(':', $this->data['ids']);
-
- /* we need at least course_id and document_id, else it's broken */
- if (count($ids)) {
- $id = $ids[1];
- }
- }
-
- return $id;
- }
-
- /**
- * Sets the parent of the current indexed item
- * @param mixed A parent object
- * @return void
- */
- function setParent($parent) {
- if (is_a($parent, 'IndexableChunk')) {
- $this->parentId = $parent->getId();
- $this->parent = False;
- } else {
- $this->parentId = -1;
- $this->parent = True;
- }
- }
-
- /**
- * Class constructor. Just generates an empty 'data' array attribute
- */
+ /**
+ * Class constructor. Just generates an empty 'data' array attribute
+ */
function __construct() {
$this->data = array();
}
- /**
- * Class desctructor. Unsets attributes.
- */
+ /**
+ * Class desctructor. Unsets attributes.
+ */
function __destruct() {
unset($this->data);
unset($this->terms);
- unset($this->parent);
}
}
/**
* Extension of the _IndexableChunk class to make IndexableChunk extensible.
*/
-class IndexableChunk extends _IndexableChunk
+class IndexableChunk extends _IndexableChunk
{
+ /**
+ * Let add tags terms
+ */
+ public function addTagTerm($term) {
+ $this->addTerm($term, XAPIAN_PREFIX_TAG);
+ }
+
+ /**
+ * Let add course id term
+ */
+ public function addCourseId($course_id) {
+ $this->addTerm($course_id, XAPIAN_PREFIX_COURSEID);
+ }
+
+ /**
+ * Let add tool id term
+ */
+ public function addToolId($tool_id) {
+ $this->addTerm($tool_id, XAPIAN_PREFIX_TOOLID);
+ }
+
}
-?>
\ No newline at end of file
+?>
diff --git a/main/inc/lib/search/search_widget.php b/main/inc/lib/search/search_widget.php
index 004498d63c..8b9fdb98f4 100644
--- a/main/inc/lib/search/search_widget.php
+++ b/main/inc/lib/search/search_widget.php
@@ -1,7 +1,20 @@
';
+
+
$htmlHeadXtra[] = '
';
+
+ $htmlHeadXtra[] ='
+
+ ';
+
$htmlHeadXtra[] = "
";
}
+/**
+ * Trim tags off first XAPIAN_PREFIX_TAG only
+ */
+function trim_tag($tag)
+{
+ if(substr($tag,0,1)==XAPIAN_PREFIX_TAG)
+ {
+ return substr($tag,1);
+ }
+ return $tag;
+}
/**
* Show the search widget
- *
+ * TODO: reorganize an clean this to reuse code
+ *
* The form will post to lp_controller.php by default, you can pass a value to
* $action to use a custom action.
* IMPORTANT: you have to call search_widget_prepare() before calling this
* function or otherwise the form will not behave correctly.
- *
+ *
* @param string $action Just in case your action is not
* lp_controller.php
*/
function search_widget_show($action="lp_controller.php") {
+ global $charset, $icons_for_search_terms;
require_once api_get_path(LIBRARY_PATH).'/search/DokeosQuery.php';
- $dktags = dokeos_query_get_tags();
+ $sf_terms = array();
+ $specific_fields = get_specific_field_list();
- $post_tags = array();
+ if ( ($cid=api_get_course_id()) != -1 ) {
+ // with cid
+ $course_filter = dokeos_get_boolean_query(XAPIAN_PREFIX_COURSEID . $cid);
+ $dktags = dokeos_query_simple_query('',0,1000,array($course_filter));
+ $dktags_org = $dktags;
+
+ $temp = array();
+ foreach($dktags[1] as $obj){
+ $temp = array_merge($obj['tags'], $temp);
+ }
+ $dktags = $temp;
+ unset($temp);
+
+ //prepare specific fields names (and also get possible URL param names)
+ $url_params = array();
+ foreach ($specific_fields as $specific_field) {
+ $temp = array();
+ foreach($dktags_org[1] as $obj) {
+ $temp = array_merge($obj['sf-'.$specific_field['code']], $temp);
+ }
+ $sf_terms[] = $temp;
+ $url_params[] = 'sf_'.$specific_field['code'];
+ unset($temp);
+ }
+ //var_dump($sf_terms);
+
+ }
+ else {
+ //without cid
+ $dktags = xapian_get_all_terms(1000, XAPIAN_PREFIX_TAG);
+ //prepare specific fields names (and also get possible URL param names)
+ $url_params = array();
+ foreach ($specific_fields as $specific_field) {
+ $temp = array();
+ //get Xapian terms for a specific term prefix, in ISO, apparently
+ $sf_terms[] = xapian_get_all_terms(1000, $specific_field['code']);
+ $url_params[] = 'sf_'.$specific_field['code'];
+ unset($temp);
+ }
+ //var_dump($sf_terms);
+ }
+
+ //check if URL params are defined (to see if we show the thesaurus or not)
+ $show_thesaurus = false;
+ foreach ($url_params as $param) {
+ if (is_array($_REQUEST[$param])) {
+ foreach ($_REQUEST[$param] as $term) {
+ if (!empty($term)) { $show_thesaurus = true; }
+ }
+ }
+ }
+ $post_tags = array();
+
if (isset($_REQUEST['tags'])) {
$filter = TRUE;
- $post_tags = explode(',', $_REQUEST['tags']);
+ $post_tags = explode(',', stripslashes($_REQUEST['tags']));
+ }
+ //sorting the array of tags and keywords
+ foreach ($dktags as $key => $value) {
+ $temp[trim(trim_tag(stripslashes(mb_convert_encoding($value['name'],$charset,'UTF-8'))))] = $key;
+ }
+
+ $temp = array_flip($temp);
+ unset($dktags);
+ natcasesort($temp);
+ $dktags = $temp;
+
+ $i = 0;
+ foreach ($temp as $key) {
+ if (in_array($key, $post_tags)==true && !empty($key)) {
+ $tags_list .= ''.(($i==0)?'':', ').$key.'';
+ $i++;
+ }
+ }
+
+ //echo '
'.get_lang('ThesaurusHelpTitle').'
'.get_lang('ThesaurusHelpComment').'
';
+ echo '
'.get_lang('LectureLibrary').'
';
+ //echo ''.get_lang('LectureLibraryIntro').'
';
+ //echo ''.get_lang('ThesaurusHelpComment').'
';
+
+ if (!empty($_SESSION['_gid'])) {
+ Display::display_introduction_section(TOOL_SEARCH.$_SESSION['_gid'],'left');
+ } else {
+ Display::display_introduction_section(TOOL_SEARCH,'left');
}
-?>
-
+
\ No newline at end of file
diff --git a/main/inc/lib/search/tool_processors/learnpath_processor.class.php b/main/inc/lib/search/tool_processors/learnpath_processor.class.php
new file mode 100644
index 0000000000..e2da08bb9b
--- /dev/null
+++ b/main/inc/lib/search/tool_processors/learnpath_processor.class.php
@@ -0,0 +1,117 @@
+rows = $rows;
+ // group by learning path
+ foreach ($rows as $row_id => $row_val) {
+ $lp_id = $row_val['xapian_data'][SE_DATA]['lp_id'];
+ $lp_item = $row_val['xapian_data'][SE_DATA]['lp_item'];
+ $document_id = $row_val['xapian_data'][SE_DATA]['document_id'];
+ $courseid = $row_val['courseid'];
+ $item = array(
+ 'courseid' => $courseid,
+ 'lp_item' => $lp_item,
+ 'score' => $row_val['score'],
+ 'row_id' => $row_id,
+ );
+ $this->learnpaths[$courseid][$lp_id][] = $item;
+ $this->learnpaths[$courseid][$lp_id]['total_score'] += $row_val['score'];
+ $this->learnpaths[$courseid][$lp_id]['has_document_id'] = is_numeric($document_id);
+ }
+ }
+
+ public function process() {
+ $results = array();
+ foreach ($this->learnpaths as $courseid => $learnpaths) {
+ $search_show_unlinked_results = (api_get_setting('search_show_unlinked_results') == 'true');
+ $course_visible_for_user = api_is_course_visible_for_user(NULL, $courseid);
+ // can view course?
+ if ($course_visible_for_user || $search_show_unlinked_results) {
+ foreach ($learnpaths as $lp_id => $lp) {
+ // is visible?
+ $visibility = api_get_item_visibility(api_get_course_info($courseid), TOOL_LEARNPATH, $lp_id);
+ if($visibility) {
+ list($thumbnail, $image, $name, $author) = $this->get_information($courseid, $lp_id, $lp['has_document_id']);
+ $url = api_get_path(WEB_PATH) . 'main/newscorm/lp_controller.php?cidReq=%s&action=view&lp_id=%s';
+ $url = sprintf($url, $courseid, $lp_id);
+ if ($search_show_unlinked_results) {
+ if (!$course_visible_for_user) {
+ $url = '';
+ }
+ $results[] = array(
+ 'toolid' => TOOL_LEARNPATH,
+ 'score' => $lp['total_score']/(count($lp)-1), // not count total_score array item
+ 'url' => $url,
+ 'thumbnail' => $thumbnail,
+ 'image' => $image,
+ 'title' => $name,
+ 'author' => $author,
+ );
+ }
+ }
+ }
+ }
+ }
+
+ // get information to sort
+ foreach ($results as $key => $row) {
+ $score[$key] = $row['score'];
+ }
+ // Sort results with score descending
+ array_multisort($score, SORT_DESC, $results);
+ return $results;
+ }
+
+ /**
+ * Get learning path information
+ */
+ private function get_information($course_id, $lp_id, $has_document_id=TRUE) {
+ $lpi_table = Database::get_course_table_from_code($course_id, TABLE_LP_ITEM);
+ $lp_table = Database::get_course_table_from_code($course_id, TABLE_LP_MAIN);
+ $doc_table = Database::get_course_table_from_code($course_id, TABLE_DOCUMENT);
+
+ if ($has_document_id) {
+ $sql = "SELECT $lpi_table.id, $lp_table.name, $lp_table.author, $doc_table.path
+ FROM $lp_table, $lpi_table
+ INNER JOIN $doc_table ON $lpi_table.path = $doc_table.id
+ WHERE $lpi_table.lp_id = $lp_id
+ AND $lpi_table.display_order = 1
+ AND $lp_table.id = $lpi_table.lp_id
+ LIMIT 1";
+ }
+ else {
+ $sql = "SELECT $lpi_table.id, $lp_table.name, $lp_table.author
+ FROM $lp_table, $lpi_table
+ WHERE $lpi_table.lp_id = $lp_id
+ AND $lpi_table.display_order = 1
+ AND $lp_table.id = $lpi_table.lp_id
+ LIMIT 1";
+ }
+
+ $dk_result = api_sql_query ($sql);
+
+ $path = '';
+ $name = '';
+ if ($row = Database::fetch_array ($dk_result)) {
+ // Get the image path
+ $img_location = api_get_path(WEB_COURSE_PATH).api_get_course_path($course_id)."/document/";
+ $thumbnail_path = str_replace ('.png.html', '_thumb.png', $row['path']);
+ $big_img_path = str_replace ('.png.html', '.png', $row['path']);
+ $thumbnail = $img_location . $thumbnail_path;
+ $image = $img_location . $big_img_path;
+ $name = $row['name'];
+ }
+
+ return array($thumbnail, $image, $name, $row['author']);
+ }
+}
+?>
diff --git a/main/inc/lib/search/tool_processors/search_processor.class.php b/main/inc/lib/search/tool_processors/search_processor.class.php
new file mode 100644
index 0000000000..65069f10e6
--- /dev/null
+++ b/main/inc/lib/search/tool_processors/search_processor.class.php
@@ -0,0 +1,25 @@
+ on
+ * TOOL_.class.php
+ * See lp_list_search for an example of calling the process.
+ */
+abstract class search_processor {
+ /**
+ * Search engine api results
+ */
+ protected $rows = array();
+
+ /**
+ * Process the data sorted by the constructor
+ */
+ abstract protected function process();
+}
+?>
diff --git a/main/inc/lib/search/xapian/XapianConsts.php b/main/inc/lib/search/xapian/XapianConsts.php
deleted file mode 100644
index d1fa23c4dd..0000000000
--- a/main/inc/lib/search/xapian/XapianConsts.php
+++ /dev/null
@@ -1,7 +0,0 @@
-
diff --git a/main/inc/lib/search/xapian/XapianIndexer.class.php b/main/inc/lib/search/xapian/XapianIndexer.class.php
index 30af364a2b..e9505a0a1e 100644
--- a/main/inc/lib/search/xapian/XapianIndexer.class.php
+++ b/main/inc/lib/search/xapian/XapianIndexer.class.php
@@ -1,5 +1,6 @@
- Xapian languages
- */
+ public $stemmer;
+
+ /**
+ * Generates a list of languages Xapian manages
+ *
+ * This method enables the definition of more matches between
+ * Dokeos languages and Xapian languages (through hardcoding)
+ * @return array Array of languages codes -> Xapian languages
+ */
public final function xapian_languages() {
/* http://xapian.org/docs/apidoc/html/classXapian_1_1Stem.html */
return array(
@@ -46,11 +46,13 @@ abstract class XapianIndexer {
);
}
- /**
- * Connect to the database, and create it if it doesn't exist
- */
+ /**
+ * Connect to the database, and create it if it doesn't exist
+ */
function connectDb($path=NULL, $dbMode=NULL, $lang='english') {
- if ($dbMode == NULL)
+ if ($this->db != NULL)
+ return $this->db;
+ if ($dbMode == NULL)
$dbMode = Xapian::DB_CREATE_OR_OPEN;
if ($path == NULL)
@@ -63,7 +65,7 @@ abstract class XapianIndexer {
if (!in_array($lang, $this->xapian_languages())) {
$lang = 'english';
}
-
+
$this->stemmer = new XapianStem($lang);
$this->indexer->set_stemmer($this->stemmer);
@@ -74,67 +76,49 @@ abstract class XapianIndexer {
return 1;
}
}
-
+
/**
* Simple getter for the db attribute
- * @return object The db attribute
+ * @return object The db attribute
*/
function getDb() {
return $this->db;
}
- /**
- * Add this chunk to the chunk array attribute
- * @param string Chunk of text
- * @return void
- */
+ /**
+ * Add this chunk to the chunk array attribute
+ * @param string Chunk of text
+ * @return void
+ */
function addChunk($chunk) {
- /*
- if ($chunk->parent) {
- $this->parents[] = $chunk;
- } else {
- $this->chunks[] = $chunk;
- }
- */
$this->chunks[] = $chunk;
}
-
+
/**
* Actually index the current data
- *
- * @return integer New Xapian document ID or NULL upon failure
+ *
+ * @return integer New Xapian document ID or NULL upon failure
*/
function index() {
try {
foreach ($this->chunks as $chunk) {
$doc = new XapianDocument();
$this->indexer->set_document($doc);
-
+
foreach ($chunk->terms as $term) {
/* FIXME: think of getting weight */
$doc->add_term($term['flag'] . $term['name'], 1);
}
- /* free-form ignoring ids, indexes title and content */
+ // free-form index all data array (title, content, etc)
foreach ($chunk->data as $key => $value) {
- //if text is empty, we don't index (because it triggers a Xapian error)
- if ($key != 'ids' && !empty($value))
- $this->indexer->index_text($value, 1);
+ $this->indexer->index_text($value, 1);
}
-
- /* Hard-coded approach */
- /*
- if (array_key_exists ('title', $chunk->data))
- $this->indexer->index_text($chunk->data['title'], 1);
- */
-
- $doc->set_data($chunk->data['ids'], 1);
- $id = $chunk->getId();
- if ($id < 0)
- return NULL;
-
- $did = $this->db->replace_document($id, $doc);
-
+
+ $doc->set_data($chunk->xapian_data, 1);
+
+ $did = $this->db->add_document($doc);
+
//write to disk
$this->db->flush();
@@ -152,13 +136,43 @@ abstract class XapianIndexer {
* Get a specific document from xapian db
*
* @param int did Xapian::docid
- * @return XapianDocument
+ * @return mixed XapianDocument, or false on error
*/
function get_document($did) {
- if ($path == NULL) {
+ if ($this->db == NULL) {
+ $this->connectDb();
+ }
+ try {
+ $docid = $this->db->get_document($did);
+ }
+ catch (Exception $e) {
+ //Display::display_error_message($e->getMessage());
+ return false;
+ }
+ return $docid;
+ }
+
+ /**
+ * Get document data on a xapian document
+ *
+ * @param XapianDocument $doc xapian document to push into the db
+ * @return mixed xapian document data or FALSE if error
+ */
+ function get_document_data($doc) {
+ if ($this->db == NULL) {
$this->connectDb();
}
- return $this->db->get_document($did);
+ try {
+ if (!is_a($doc, 'XapianDocument')) {
+ return FALSE;
+ }
+ $doc_data = $doc->get_data();
+ return $doc_data;
+ }
+ catch (Exception $e) {
+ //Display::display_error_message($e->getMessage());
+ return false;
+ }
}
/**
@@ -166,9 +180,11 @@ abstract class XapianIndexer {
*
* @param int did Xapian::docid
* @param array terms New terms of the document
+ * @return boolean false on error
*/
- function update_terms($did, $terms, $prefix='T') {
+ function update_terms($did, $terms, $prefix=XAPIAN_PREFIX_TAG) {
$doc = $this->get_document($did);
+ if($doc===false){return false;}
$doc->clear_terms();
foreach ($terms as $term) {
//add directly
@@ -176,6 +192,7 @@ abstract class XapianIndexer {
}
$this->db->replace_document($did, $doc);
$this->db->flush();
+ return true;
}
/**
@@ -184,16 +201,85 @@ abstract class XapianIndexer {
* @param int did Xapian::docid
*/
function remove_document($did) {
- if ($path == NULL) {
+ if ($this->db == NULL) {
$this->connectDb();
}
- $this->db->delete_document($did);
- $this->db->flush();
+ if (is_numeric($did) && $did>0) {
+ $doc = $this->get_document($did);
+ if ($doc !== FALSE) {
+ $this->db->delete_document($did);
+ $this->db->flush();
+ }
+ }
}
- /**
- * Class contructor
- */
+ /**
+ * Adds a term to the document specified
+ *
+ * @param string $term The term to add
+ * @param XapianDocument $doc The xapian document where to add the term
+ * @return mixed XapianDocument, or false on error
+ */
+ function add_term_to_doc($term, $doc) {
+ if (!is_a($doc,'XapianDocument')) {
+ return FALSE;
+ }
+ try {
+ $doc->add_term($term);
+ }
+ catch (Exception $e) {
+ Display::display_error_message($e->getMessage());
+ return 1;
+ }
+ }
+
+ /**
+ * Remove a term from the document specified
+ *
+ * @param string $term The term to add
+ * @param XapianDocument $doc The xapian document where to add the term
+ * @return mixed XapianDocument, or false on error
+ */
+ function remove_term_from_doc($term, $doc) {
+ if (!is_a($doc,'XapianDocument')) {
+ return FALSE;
+ }
+ try {
+ $doc->remove_term($term);
+ }
+ catch (Exception $e) {
+ Display::display_error_message($e->getMessage());
+ return 1;
+ }
+ }
+
+ /**
+ * Replace a document in the actual db
+ *
+ * @param XapianDocument $doc xapian document to push into the db
+ * @param Xapian::docid $did xapian document id of the document to replace
+ */
+ function replace_document($doc, $did) {
+ if (!is_a($doc,'XapianDocument')) {
+ return FALSE;
+ }
+ if ($this->db == NULL) {
+ $this->connectDb();
+ }
+ try {
+ $this->getDb()->replace_document((int)$did, $doc);
+ $this->getDb()->flush();
+ }
+ catch (Exception $e) {
+ Display::display_error_message($e->getMessage());
+ return 1;
+ }
+ }
+
+
+ /**
+ * Class contructor
+ */
function __construct() {
$this->db = NULL;
$this->stemmer = NULL;
diff --git a/main/inc/lib/search/xapian/XapianQuery.php b/main/inc/lib/search/xapian/XapianQuery.php
index c17feffbab..18d3878fac 100644
--- a/main/inc/lib/search/xapian/XapianQuery.php
+++ b/main/inc/lib/search/xapian/XapianQuery.php
@@ -1,58 +1,68 @@
set_stemmer($stemmer);
- $query_parser->set_database($db);
- $query_parser->set_stemming_strategy(XapianQueryParser::STEM_SOME);
- $query_parser->add_boolean_prefix('filetype', 'F');
- $query_parser->add_boolean_prefix('tag', 'T');
- $query_parser->add_boolean_prefix('courseid', 'C');
- $query = $query_parser->parse_query($query_string);
-
- // Build subqueries from $extra array.
- foreach ($extra as $subq) {
- if (!empty($subq)) {
- /* TODO: review if we want to use this constructor
- * deprecated in C: http://xapian.org/docs/apidoc/html/classXapian_1_1Query.html#f85d155b99f1f2007fe75ffc7a8bd51e
- * maybe use: Query (Query::op op_, const Query &left, const Query &right) ?
- */
- $subquery = new XapianQuery(XapianQuery::OP_OR, $subq);
- $query = new XapianQuery(XapianQuery::OP_AND, array($subquery, $query));
+ // Build subqueries from $extra array. Now only used by tags search filter on search widget
+ $subqueries = array();
+ foreach ($extra as $subquery) {
+ if (!empty($subquery)) {
+ $subqueries[] = new XapianQuery($subquery);
}
}
+ $query = NULL;
+ $enquire = new XapianEnquire($db);
+
+ if (!empty($query_string)) {
+ $query_parser = new XapianQueryParser();
+ //TODO: choose stemmer
+ $stemmer = new XapianStem("english");
+ $query_parser->set_stemmer($stemmer);
+ $query_parser->set_database($db);
+ $query_parser->set_stemming_strategy(XapianQueryParser::STEM_SOME);
+ $query_parser->add_boolean_prefix('tag', XAPIAN_PREFIX_TAG);
+ $query_parser->add_boolean_prefix('courseid', XAPIAN_PREFIX_COURSEID);
+ $query_parser->add_boolean_prefix('toolid', XAPIAN_PREFIX_TOOLID);
+ $query = $query_parser->parse_query($query_string);
+ $query = new XapianQuery(XapianQuery::OP_AND, array_merge($subqueries, array($query)));
+ }
+ else {
+ $query = new XapianQuery(XapianQuery::OP_OR, $subqueries);
+ }
+
$enquire->set_query($query);
$matches = $enquire->get_mset((int)$start, (int)$length);
+ $specific_fields = get_specific_field_list();
+
$results = array();
$i = $matches->begin();
$count = 0;
@@ -60,9 +70,21 @@ function xapian_query($query_string, $db = NULL, $start = 0, $length = 10,
$count++;
$document = $i->get_document();
if (is_object($document)) {
- $results[$count]->ids = ($document->get_data());
- $results[$count]->score = ($i->get_percent());
- $results[$count]->terms = xapian_get_doc_terms($document);
+ // process one item terms
+ $courseid_terms = xapian_get_doc_terms($document, XAPIAN_PREFIX_COURSEID);
+ $results[$count]['courseid'] = substr($courseid_terms[0]['name'], 1);
+ $toolid_terms = xapian_get_doc_terms($document, XAPIAN_PREFIX_TOOLID);
+ $results[$count]['toolid'] = substr($toolid_terms[0]['name'], 1);
+
+ // process each specific field prefix
+ foreach ($specific_fields as $specific_field) {
+ $results[$count]['sf-'.$specific_field['code']] = xapian_get_doc_terms($document, $specific_field['code']);
+ }
+
+ // rest of data
+ $results[$count]['xapian_data'] = unserialize($document->get_data());
+ $results[$count]['score'] = ($i->get_percent());
+ $results[$count]['tags'] = xapian_get_doc_terms($document);
}
$i->next();
}
@@ -71,7 +93,7 @@ function xapian_query($query_string, $db = NULL, $start = 0, $length = 10,
case 1: // Lower bound
$count = $matches->get_matches_lower_bound();
break;
-
+
case 2: // Upper bound
$count = $matches->get_matches_upper_bound();
break;
@@ -90,15 +112,21 @@ function xapian_query($query_string, $db = NULL, $start = 0, $length = 10,
}
}
+/**
+ * build a boolean query
+ */
+function xapian_get_boolean_query($term) {
+ return new XapianQuery($term);
+}
/**
* Retrieve a list db terms
- *
+ *
* @param int $count Number of terms to retrieve
* @param char $prefix The prefix of the term to retrieve
* @param XapianDatabase $db Xapian database to connect
* @return array
*/
-function xapian_get_all_terms($count=0, $prefix='T', $db=NULL) {
+function xapian_get_all_terms($count=0, $prefix=XAPIAN_PREFIX_TAG, $db=NULL) {
try {
if (!is_object($db)) {
$db = new XapianDatabase(XAPIAN_DB);
@@ -134,7 +162,7 @@ function xapian_get_all_terms($count=0, $prefix='T', $db=NULL) {
* @param XapianDocument document searched
* @return array
*/
-function xapian_get_doc_terms($doc=NULL, $prefix='T') {
+function xapian_get_doc_terms($doc=NULL, $prefix=XAPIAN_PREFIX_TAG) {
try {
if (!is_a($doc, 'XapianDocument')) {
return;
@@ -161,4 +189,35 @@ function xapian_get_doc_terms($doc=NULL, $prefix='T') {
return NULL;
}
}
+
+/**
+ * Join xapian queries
+ *
+ * @param XapianQuery|array $query1
+ * @param XapianQuery|array $query2
+ * @param string $op
+ * @return XapianQuery query joined
+ */
+function xapian_join_queries($query1, $query2=NULL, $op='or') {
+ // let decide how to join, avoiding include xapian.php outside
+ switch ($op) {
+ case 'or': $op = XapianQuery::OP_OR; break;
+ case 'and': $op = XapianQuery::OP_AND; break;
+ default: $op = XapianQuery::OP_OR; break;
+ }
+
+ // review parameters to decide how to join
+ if (!is_array($query1)) {
+ $query1 = array($query1);
+ }
+ if (is_null($query2)) {
+ // join an array of queries with $op
+ return new XapianQuery($op, $query1);
+ }
+ if (!is_array($query2)) {
+ $query2 = array($query2);
+ }
+
+ return new XapianQuery($op, array_merge($query1, $query2));
+}
?>
diff --git a/main/inc/lib/specific_fields_manager.lib.php b/main/inc/lib/specific_fields_manager.lib.php
new file mode 100644
index 0000000000..43336dbfcf
--- /dev/null
+++ b/main/inc/lib/specific_fields_manager.lib.php
@@ -0,0 +1,226 @@
+STUDENT)
+ * @param array $order_by a list of fields on which to sort
+ * @return array An array with all specific fields, at platform level
+ */
+function get_specific_field_list($conditions = array(), $order_by = array()) {
+ $table_sf = Database :: get_main_table(TABLE_MAIN_SPECIFIC_FIELD);
+ $return_array = array();
+ $sql = "SELECT * FROM $table_sf";
+ if (count($conditions) > 0) {
+ $sql .= ' WHERE ';
+ $conditions_string_array = array();
+ foreach ($conditions as $field => $value) {
+ $conditions_string_array[] = $field.' = '. $value;
+ }
+ $sql .= implode(' AND ', $conditions_string_array);
+ }
+ if (count($order_by) > 0) {
+ $sql .= ' ORDER BY '.implode(',',$order_by);
+ }
+ $sql_result = api_sql_query($sql,__FILE__,__LINE__);
+ while ($result = Database::fetch_array($sql_result)) {
+ $return_array[] = $result;
+ }
+
+ return $return_array;
+}
+
+/**
+ * @param array $conditions a list of condition (exemple : status=>STUDENT)
+ * @param array $order_by a list of fields on which sort
+ * @return array An array with all users of the platform.
+ */
+function get_specific_field_values_list($conditions = array(), $order_by = array()) {
+ $table_sfv = Database :: get_main_table(TABLE_MAIN_SPECIFIC_FIELD_VALUES);
+ $return_array = array();
+ $sql = "SELECT * FROM $table_sfv";
+ if (count($conditions) > 0) {
+ $sql .= ' WHERE ';
+ $conditions_string_array = array();
+ foreach ($conditions as $field => $value) {
+ $conditions_string_array[] = $field.' = '. $value;
+ }
+ $sql .= implode(' AND ', $conditions_string_array);
+ }
+ if (count($order_by) > 0) {
+ $sql .= ' ORDER BY '.implode(',',$order_by);
+ }
+ $sql_result = api_sql_query($sql,__FILE__,__LINE__);
+ while ($result = Database::fetch_array($sql_result)) {
+ $return_array[] = $result;
+ }
+
+ return $return_array;
+}
+
+/**
+ * @param char $prefix xapian prefix
+ * @param string $course_code
+ * @param string $tool_id Constant from mainapi.lib.php
+ * @param int $ref_id representative id inside one tool item
+ * @return array
+ */
+function get_specific_field_values_list_by_prefix($prefix, $course_code, $tool_id, $ref_id) {
+ $table_sf = Database :: get_main_table(TABLE_MAIN_SPECIFIC_FIELD);
+ $table_sfv = Database :: get_main_table(TABLE_MAIN_SPECIFIC_FIELD_VALUES);
+ $sql = 'SELECT sfv.value FROM %s sf LEFT JOIN %s sfv ON sf.id = sfv.field_id' .
+ ' WHERE sf.code = \'%s\' AND sfv.course_code = \'%s\' AND tool_id = \'%s\' AND sfv.ref_id = %s';
+ $sql = sprintf($sql, $table_sf, $table_sfv, $prefix, $course_code, $tool_id, $ref_id);
+ $sql_result = api_sql_query($sql,__FILE__,__LINE__);
+ while ($result = Database::fetch_array($sql_result)) {
+ $return_array[] = $result;
+ }
+ return $return_array;
+}
+
+/**
+ * Add a specific field value
+ * @param int $id_specific_field specific field id
+ * @param string $course_id course code
+ * @param string $tool_id tool id, from main.api.lib
+ * @param int $ref_id intern id inside specific tool table
+ * @param string $value specific field value
+ */
+function add_specific_field_value($id_specific_field, $course_id, $tool_id, $ref_id, $value) {
+ $table_sf_values = Database :: get_main_table(TABLE_MAIN_SPECIFIC_FIELD_VALUES);
+ $value = trim($value);
+ if (empty($value)) {
+ return FALSE;
+ }
+ $sql = 'INSERT INTO %s(id, course_code, tool_id, ref_id, field_id, value) VALUES(NULL, \'%s\', \'%s\', %s, %s, \'%s\')';
+ $sql = sprintf($sql, $table_sf_values, $course_id, $tool_id, $ref_id, $id_specific_field, Database::escape_string($value));
+ $result = api_sql_query($sql,__FILE__,__LINE__);
+ if ($result) {
+ return Database::get_last_insert_id();
+ }
+ else {
+ return FALSE;
+ }
+}
+
+/**
+ * Delete all values from a specific field id, course_id, ref_id and tool
+ * @param string $course_id course code
+ * @param int $id_specific_field specific field id
+ * @param string $tool_id tool id, from main.api.lib
+ * @param int $ref_id intern id inside specific tool table
+ */
+function delete_all_specific_field_value($course_id, $id_specific_field, $tool_id, $ref_id) {
+ $table_sf_values = Database :: get_main_table(TABLE_MAIN_SPECIFIC_FIELD_VALUES);
+ $sql = 'DELETE FROM %s WHERE course_code = \'%s\' AND tool_id = \'%s\' AND ref_id = %s AND field_id = %s';
+ $sql = sprintf($sql, $table_sf_values, $course_id, $tool_id, $ref_id, $id_specific_field);
+ $result = api_sql_query($sql,__FILE__,__LINE__);
+}
+
+/**
+ * Delete all values from a specific item (course_id, tool_id and ref_id).
+ * To be used when deleting such item from Dokeos
+ * @param string Course code
+ * @param string Tool ID
+ * @param int Internal ID used in specific tool table
+ */
+function delete_all_values_for_item($course_id, $tool_id, $ref_id) {
+ $table_sf_values = Database :: get_main_table(TABLE_MAIN_SPECIFIC_FIELD_VALUES);
+ $sql = 'DELETE FROM %s WHERE course_code = \'%s\' AND tool_id = \'%s\' AND ref_id = %s';
+ $sql = sprintf($sql, $table_sf_values, $course_id, $tool_id, $ref_id);
+ $result = api_sql_query($sql,__FILE__,__LINE__);
+}
+
+/**
+ * Generates a code (one-letter string) for a given field name
+ * Defaults to the first letter of the name, otherwise iterate through available
+ * letters
+ * @param string Name
+ * @return string One-letter code, upper-case
+ */
+function get_specific_field_code_from_name($name) {
+ $list = array('A','B','D','E','F','G','H','I','J','K','L','M','N','P','Q','R','S','U','V','W','X','Y'); //Z is used internally by Xapian and we already use C,T & O for tool_id, course_id and normal tags
+ $table_sf = Database :: get_main_table(TABLE_MAIN_SPECIFIC_FIELD);
+ $sql = "SELECT code FROM $table_sf ORDER BY code";
+ $res = api_sql_query($sql,__FILE__,__LINE__);
+ $code = strtoupper(substr($name,0,1));
+ //if no code exists in DB, return current one
+ if (Database::num_rows($res)<1) { return $code;}
+
+ $existing_list = array();
+ while ($row = Database::fetch_array($res)) {
+ $existing_list[] = $row['code'];
+ }
+ //if the current code doesn't exist in DB, return current one
+ if (!in_array($code,$existing_list)) { return $code;}
+
+ $idx = array_search($code,$list);
+ $c = count($list);
+ for ($i = $idx+1, $j=0 ; $j<$c ; $i++, $j++) {
+ if (!in_array($list[$i],$existing_list)) { return $idx[$i]; }
+ }
+ // all 26 codes are used
+ return false;
+}
diff --git a/main/lang/english/admin.inc.php b/main/lang/english/admin.inc.php
index 8b9df065f3..b731dee4f5 100644
--- a/main/lang/english/admin.inc.php
+++ b/main/lang/english/admin.inc.php
@@ -853,4 +853,9 @@ $ThereIsNotStillAResponsible = "No HR manager available";
$GlobalAgenda = "Global agenda";
$AdvancedfilemanagerTitle = "Advanced file manager for wysiwyg editor";
$AdvancedfilemanagerComment = "Enable advanced file manager for WYSIWYG editor? This will add a considerable amount of additional options to the file manager that opens in a pop-up window when uploading files to the server.";
-?>
\ No newline at end of file
+$SpecificSearchFields = "Specific search fields";
+$AddSpecificSearchField = "Add a specific search field";
+$EditSpecificSearchField = "Edit a specific search field";
+$FieldName = "Field name";
+$SpecificSearchFieldsIntro = "Adding a specific search field will enable the indexation of extra fields together with documents contents. This will add fields to the import and edition pages of the lectures tool.";
+?>
diff --git a/main/lang/english/learnpath.inc.php b/main/lang/english/learnpath.inc.php
index 50af280d83..fae91e47f9 100644
--- a/main/lang/english/learnpath.inc.php
+++ b/main/lang/english/learnpath.inc.php
@@ -212,4 +212,17 @@ $UplAlreadyExists = "File already exists";
$UnknownPackageFormat = "Unknown package format";
$UplUnableToSaveFile = "Unable to save file";
$UnknownPackageFormat = "The format of this package could not be recognized. Please check this is a valid package.";
-?>
\ No newline at end of file
+$GoToThisLearningPath = "Watch lecture";
+//$LectureLibrary = "";
+$ImageWillResizeMsg = "If necesarry, the image will be resized to fit the screen";
+$SearchFeatureTerms = "Keywords for search engine";
+$SaveLPSettings = "Save course settings";
+$EditLPSettings = "Course settings";
+$UploadMp3audio = 'Upload MP3 audio';
+$UpdateAllAudioFragments = 'Update all audio fragments';
+$Audio = 'Audio';
+$RemoveAudio = 'Remove audio file';
+$SaveAudio = 'Save audio files';
+$LeaveEmptyToKeepCurrentFile = 'If you want to keep the current file you can leave the input field empty';
+//$Lectures = "";
+?>
diff --git a/main/lang/english/trad4all.inc.php b/main/lang/english/trad4all.inc.php
index d327751d86..eca3903c48 100644
--- a/main/lang/english/trad4all.inc.php
+++ b/main/lang/english/trad4all.inc.php
@@ -630,4 +630,18 @@ $langNameOfLang['trad_chinese'] = "traditional chinese";
$langNameOfLang['turkce'] = "turkish";
$langNameOfLang['ukrainian'] = "ukrainian";
$langNameOfLang['yoruba'] = "yoruba";
-?>
\ No newline at end of file
+//$GoToLearningPath = "";
+//$LectureLibrary = "";
+//$ImagePreview= "";
+$ShowTags = "Show/hide thesaurus";
+$EraseTags = "Erase thesaurus";
+$CleanTags = "Cancel";
+$Keywords = "Keywords";
+$IntroductionTextDeleted = "The introduction text has been deleted.";
+//$LectureLibraryIntro = "";
+$ThesaurusHelpTitle = "Thesaurus help";
+$ThesaurusHelpComment = "Select keywords in one or more fields and click the \"Search\" button.
To select more than one keyword in a field, use Ctrl+click.";
+$Validate = "Validate";
+$CombineSearchWith = "Combine with";
+$SearchFeatureNotEnabledComment = "The full-text search feature is not enabled in Dokeos. Please contact the Dokeos administrator.";
+?>
diff --git a/main/newscorm/learnpath.class.php b/main/newscorm/learnpath.class.php
index b7d2eb8ef0..41c9977adf 100644
--- a/main/newscorm/learnpath.class.php
+++ b/main/newscorm/learnpath.class.php
@@ -856,6 +856,10 @@ class learnpath {
$this->update_display_order();//updates the display order of all lps
api_item_property_update(api_get_course_info(),TOOL_LEARNPATH,$this->lp_id,'delete',api_get_user_id());
//TODO: also delete items and item-views
+ if (api_get_setting('search_enabled') == 'true') {
+ require_once(api_get_path(LIBRARY_PATH) .'specific_fields_manager.lib.php');
+ $r = delete_all_values_for_item($this->cc, TOOL_LEARNPATH, $this->lp_id);
+ }
}
/**
@@ -919,9 +923,19 @@ class learnpath {
$res_all = api_sql_query($sql_all,__FILE__,__LINE__);
// remove from search engine if enabled
if (api_get_setting('search_enabled') == 'true') {
+ $tbl_se_ref = Database::get_main_table(TABLE_MAIN_SEARCH_ENGINE_REF);
+ $sql = 'SELECT * FROM %s WHERE course_code=\'%s\' AND tool_id=\'%s\' AND ref_id_high_level=%s AND ref_id_second_level=%d LIMIT 1';
+ $sql = sprintf($sql, $tbl_se_ref, $this->cc, TOOL_LEARNPATH, $lp, $id);
+ $res = api_sql_query($sql, __FILE__, __LINE__);
+ if (Database::num_rows($res) > 0) {
+ $row2 = Database::fetch_array($res);
require_once(api_get_path(LIBRARY_PATH) .'search/DokeosIndexer.class.php');
$di = new DokeosIndexer();
- $di->remove_document($row['search_did']);
+ $di->remove_document((int)$row2['search_did']);
+ }
+ $sql = 'DELETE FROM %s WHERE course_code=\'%s\' AND tool_id=\'%s\' AND ref_id_high_level=%s AND ref_id_second_level=%d LIMIT 1';
+ $sql = sprintf($sql, $tbl_se_ref, $this->cc, TOOL_LEARNPATH, $lp, $id);
+ api_sql_query($sql, __FILE__, __LINE__);
}
}
@@ -934,10 +948,10 @@ class learnpath {
* @param string Item description
* @param string Prerequisites (optional)
* @param string Indexing terms (optional)
+ * @param array The array resulting of the $_FILES[mp3] element
* @return boolean True on success, false on error
*/
- function edit_item($id, $parent, $previous, $title, $description, $prerequisites=0, $terms=NULL)
- {
+ function edit_item($id, $parent, $previous, $title, $description, $prerequisites=0, $audio=NULL) {
if($this->debug > 0){error_log('New LP - In learnpath::edit_item()', 0);}
if(empty($id) or ($id != strval(intval($id))) or empty($title)){ return false; }
@@ -951,16 +965,17 @@ class learnpath {
$res_select = api_sql_query($sql_select, __FILE__, __LINE__);
$row_select = Database::fetch_array($res_select);
- $terms_update_sql='';
- if (!is_null($terms)) {
- //TODO: validate csv string
- $terms_update_sql = ", terms = '". $this->escape_string(htmlentities($terms)) . "'";
-
- // save it to search engine
- if (api_get_setting('search_enabled') == 'true') {
- require_once(api_get_path(LIBRARY_PATH).'search/DokeosIndexer.class.php');
- $di = new DokeosIndexer();
- $di->update_terms($row_select['search_did'], explode(',', $terms));
+ $audio_update_sql = '';
+ if (is_array($audio) && !empty($audio['tmp_name']) && $audio['error']===0) {
+ //upload file in documents
+ $pi = pathinfo($audio['name']);
+ if ($pi['extension'] == 'mp3') {
+ $c_det = api_get_course_info($this->cc);
+ $bp = api_get_path(SYS_COURSE_PATH).$c_det['path'].'/document';
+ $path = handle_uploaded_document($c_det,$audio,$bp,'/audio',api_get_user_id(),0,null,'',0,'rename',false,0);
+ $path = substr($path,7);
+ //update reference in lp_item - audio path is the path from inside de document/audio/ dir
+ $audio_update_sql = ", audio = '".Database::escape_string($path)."' ";
}
}
@@ -976,7 +991,7 @@ class learnpath {
title = '" . $this->escape_string(htmlentities($title)) . "',
prerequisite = '".$prerequisites."',
description = '" . $this->escape_string(htmlentities($description)) . "'
- ". $terms_update_sql . "
+ ". $audio_update_sql . "
WHERE id = " . $id;
$res_update = api_sql_query($sql_update, __FILE__, __LINE__);
}
@@ -1094,7 +1109,7 @@ class learnpath {
previous_item_id = " . $previous . ",
next_item_id = " . $new_next . ",
display_order = " . $new_order . "
- ". $terms_update_sql . "
+ ". $audio_update_sql . "
WHERE id = " . $id;
$res_update_next = api_sql_query($sql_update, __FILE__, __LINE__);
//echo '
' . $sql_update . '
';
@@ -1375,36 +1390,25 @@ class learnpath {
}
/**
- * Get the index terms shared between all items of this path
- * @return string String of terms, split by a simple comma
+ * Get the specific prefix index terms of this learning path
+ * @return array Array of terms
*/
- function get_common_index_terms()
+ function get_common_index_terms_by_prefix($prefix)
{
- $terms = array();
- $i = 0;
- foreach ( $this->items as $item ) {
- $i_terms = split(',',$item->terms);
- if ( $i == 0 ) { $terms = $i_terms; continue; }
+ require_once api_get_path(LIBRARY_PATH) . 'specific_fields_manager.lib.php';
+ $terms = get_specific_field_values_list_by_prefix($prefix, $this->cc, TOOL_LEARNPATH, $this->lp_id);
+ $prefix_terms = array();
foreach($terms as $term)
{
- if ( !in_array($term,$i_terms) )
- {
- $terms = array_diff($terms,array($term)); //remove term from terms array because it is not in the current item's terms (so it is not common to all)
- }
- }
+ $prefix_terms[] = $term['value'];
}
- $s = implode(',',$terms);
- return $s;
+ return $prefix_terms;
}
/**
-
* Gets the number of items currently completed
-
* @return integer The number of items currently completed
-
*/
-
function get_complete_items_count()
{
@@ -3021,6 +3025,20 @@ class learnpath {
}
}
/**
+ * Checks if any of the items has an audio element attached
+ * @return bool True or false
+ */
+ function has_audio() {
+ $has = false;
+ foreach ($this->items as $i=>$item) {
+ if (!empty($this->items[$i]->audio)) {
+ $has = true;
+ break;
+ }
+ }
+ return $has;
+ }
+ /**
* Logs a message into a file
* @param string Message to log
* @return boolean True on success, false on error or if msg empty
@@ -3661,20 +3679,80 @@ class learnpath {
return true;
}
+
/**
- * Set index terms for all items in this path
+ * Set index specified prefix terms for all items in this path
* @param string Comma-separated list of terms
+ * @param char Xapian term prefix
* @return boolean False on error, true otherwise
*/
- function set_terms($terms) {
- if ( empty($terms) ) return false;
- if ( trim($terms) == trim($this->get_common_index_terms()) ) return false; //indexing is costly, don't re-index if no change
+ function set_terms_by_prefix($terms_string, $prefix) {
+ if (api_get_setting('search_enabled') !== 'true')
+ return FALSE;
+
+ $terms_string = trim($terms_string);
+ $terms = explode(',', $terms_string);
+ array_walk($terms, 'trim_value');
+
+ $stored_terms = $this->get_common_index_terms_by_prefix($prefix);
+ //var_dump($stored_terms);
+ //var_dump($terms);
+
+ // don't do anything if no change, verify only at DB, not the search engine
+ if ( (count(array_diff($terms, $stored_terms))==0) && (count(array_diff($stored_terms, $terms))==0) )
+ return FALSE;
+
+ require_once('xapian.php'); //TODO try catch every xapian use or make wrappers on api
+ require_once(api_get_path(LIBRARY_PATH).'search/DokeosIndexer.class.php');
+ require_once(api_get_path(LIBRARY_PATH).'search/xapian/XapianQuery.php');
+ require_once(api_get_path(LIBRARY_PATH).'search/IndexableChunk.class.php');
+
+ $items_table = Database::get_course_table('lp_item');
+ //TODO: make query secure agains XSS : use member attr instead of post var
+ $lp_id = $_POST['lp_id'];
+ $sql = "SELECT * FROM $items_table WHERE lp_id = $lp_id";
+ $result = api_sql_query($sql);
+ $di = new DokeosIndexer();
- foreach ( $this->items as $item ) {
- $item->set_terms($terms);
+ while($lp_item = Database::fetch_array($result))
+ {
+ // get search_did
+ $tbl_se_ref = Database::get_main_table(TABLE_MAIN_SEARCH_ENGINE_REF);
+ $sql = 'SELECT * FROM %s WHERE course_code=\'%s\' AND tool_id=\'%s\' AND ref_id_high_level=%s AND ref_id_second_level=%d LIMIT 1';
+ $sql = sprintf($sql, $tbl_se_ref, $this->cc, TOOL_LEARNPATH, $lp_id, $lp_item['id']);
+ $res = api_sql_query($sql, __FILE__, __LINE__);
+ $se_ref = Database::fetch_array($res);
+
+ // compare terms
+ $doc = $di->get_document($se_ref['search_did']);
+ $xapian_terms = xapian_get_doc_terms($doc, $prefix);
+ //var_dump($xapian_terms);
+ $xterms = array();
+ foreach ($xapian_terms as $xapian_term) $xterms[] = substr($xapian_term['name'],1);
+
+ $dterms = $terms;
+ //var_dump($xterms);
+ //var_dump($dterms);
+
+ $missing_terms = array_diff($dterms, $xterms);
+ $deprecated_terms = array_diff($xterms, $dterms);
+
+ // save it to search engine
+ foreach ($missing_terms as $term)
+ {
+ $doc->add_term($prefix. $term, 1);
+ }
+ foreach ($deprecated_terms as $term)
+ {
+ $doc->remove_term($prefix.$term);
+ }
+ $di->getDb()->replace_document((int)$se_ref['search_did'], $doc);
+ $di->getDb()->flush();
}
+
return true;
}
+
/**
* Sets the theme of the LP (local/remote) (and save)
* @param string Optional string giving the new theme of this learnpath
@@ -6465,12 +6543,14 @@ class learnpath {
$form->addElement('file','mp3',get_lang('UploadMp3audio'),'id="mp3" size="33"');
$form->addRule('file', 'The extension of the Song file should be *.mp3', 'filename', '/^.*\.mp3$/');
+ /* Code deprecated - moved to lp level (not lp-item)
if ( api_get_setting('search_enabled') === 'true' )
{
//add terms field
$terms = $form->addElement('text','terms', get_lang('SearchFeatureTerms').' :','id="idTerms" class="learnpath_item_form"');
$terms->setValue($item_terms);
}
+ */
$arrHide=array();
@@ -8836,30 +8916,13 @@ EOD;
}
return false;
}
- /**
- * Create a new attempt for the current learning path. This is similar to
- * the restart() method, except that this version is to be used statically.
- * Call this function to define a new attempt for the given path and user,
- * then reload the learning path object with the user and it will offer
- * a new attempt.
- * @param int Learning path ID
- * @param int User ID
- * @return New attempt ID (new view ID from the database)
- */
- function create_new_attempt($lp_id,$user_id) {
- $lp_id = (int) $lp_id;
- $user_id = (int) $user_id;
- $t = Database::get_course_table(TABLE_LP_VIEW);
- $sql = "SELECT max(view_count) FROM $t WHERE lp_id = $lp_id AND user_id = $user_id";
- $res = api_sql_query($sql,__FILE__,__LINE__);
- if ($res === false) { return 0;}
- if (Database::num_rows($res)!=1) { return 0;}
- $row = Database::fetch_array($res);
- $vc = $row[0]+1;
- $sqlins = "INSERT INTO $t (lp_id,user_id,view_count,last_item,progress) VALUES ($lp_id,$user_id, $vc,0,0)";
- $resins = api_sql_query($sql,__FILE__,__LINE__);
- if ($resins === false) { return 0; }
- return $vc;
+
+}
+
+if (!function_exists('trim_value')) {
+ function trim_value(&$value) {
+ $value = trim($value);
}
}
-?>
\ No newline at end of file
+
+?>
diff --git a/main/newscorm/learnpathItem.class.php b/main/newscorm/learnpathItem.class.php
index 7a16499289..03d8a3560e 100644
--- a/main/newscorm/learnpathItem.class.php
+++ b/main/newscorm/learnpathItem.class.php
@@ -12,6 +12,7 @@
*/
class learnpathItem{
var $attempt_id; //also called "objectives" SCORM-wise
+ var $audio; //the path to an audio file (stored in document/audio/)
var $children = array(); //contains the ids of children items
var $condition; //if this item has a special condition embedded
var $current_score;
@@ -49,12 +50,11 @@ class learnpathItem{
var $prevent_reinit = 1;
var $ref;
var $save_on_close = true;
+ var $search_did = NULL;
var $status;
var $title;
var $type; // this attribute can contain chapter|link|student_publication|module|quiz|document|forum|thread
var $view_id;
- var $terms;
- var $search_did;
var $debug = 0; //logging param
/**
@@ -100,10 +100,20 @@ class learnpathItem{
if(isset($row['launch_data'])){
$this->launch_data = $row['launch_data'];
}
- $this->terms = $row['terms'];
- $this->search_did = $row['search_did'];
- $this->save_on_close = true;
+ $this->save_on_close = true;
$this->db_id = $id;
+
+ // get search_did
+ $tbl_se_ref = Database::get_main_table(TABLE_MAIN_SEARCH_ENGINE_REF);
+ $sql = 'SELECT * FROM %s WHERE course_code=\'%s\' AND tool_id=\'%s\' AND ref_id_high_level=%s AND ref_id_second_level=%d LIMIT 1';
+ // TODO: verify if it's possible to assume the actual course instead of getting it from db
+ $sql = sprintf($sql, $tbl_se_ref, api_get_course_id(), TOOL_LEARNPATH, $this->lp_id, $id);
+ $res = api_sql_query($sql, __FILE__, __LINE__);
+ if (Database::num_rows($res) > 0) {
+ $se_ref = Database::fetch_array($res);
+ $this->search_did = (int)$se_ref['search_did'];
+ }
+ $this->audio = $row['audio'];
//error_log('New LP - End of learnpathItem constructor for item '.$id,0);
return true;
@@ -199,10 +209,25 @@ class learnpathItem{
$lp_item = Database::get_course_table('lp_item');
$sql_del_view = "DELETE FROM $lp_item_view WHERE item_id = ".$this->db_id;
//error_log('New LP - Deleting from lp_item_view: '.$sql_del_view,0);
- $res_del_view = api_sql_query($sql_del_view);
+ $res_del_view = api_sql_query($sql_del_view);
+
+ $sql_sel = "SELECT * FROM $lp_item WHERE id = ".$this->db_id;
+ $res_sel = api_sql_query($sql_sel,__FILE__,__LINE__);
+ if(Database::num_rows($res_sel)<1){return false;}
+ $row = Database::fetch_array($res_sel);
+
$sql_del_item = "DELETE FROM $lp_item WHERE id = ".$this->db_id;
//error_log('New LP - Deleting from lp_item: '.$sql_del_view,0);
- $res_del_item = api_sql_query($sql_del_item);
+ $res_del_item = api_sql_query($sql_del_item);
+
+ if (api_get_setting('search_enabled') == 'true') {
+ if (!is_null($this->search_did)) {
+ require_once(api_get_path(LIBRARY_PATH) .'search/DokeosIndexer.class.php');
+ $di = new DokeosIndexer();
+ $di->remove_document($this->search_did);
+ }
+ }
+
return true;
}
/**
@@ -1054,20 +1079,15 @@ class learnpathItem{
}
return $scorm_time;
}
- /**
- * Returns search index's internal ID
- * @return int The indexing engine's internal ID for this lp-item
- */
- function get_search_id() {
- return $this->search_did;
- }
- /**
- * Returns index terms
- * @return string Comma-separated list of index terms
- */
- function get_terms() {
- return $this->terms;
- }
+
+function get_terms()
+ {
+ $lp_item = Database::get_course_table(TABLE_LP_ITEM);
+ $sql = "SELECT * FROM $lp_item WHERE id='".Database::escape_string($this->db_id)."'";
+ $res = api_sql_query($sql,__FILE__,__LINE__);
+ $row = Database::fetch_array($res);
+ return $row['terms'];
+ }
/**
* Returns the item's title
* @return string Title
@@ -1939,9 +1959,9 @@ class learnpathItem{
return false;
}
/**
- * Sets new index terms for item
- * @param string Comma-separated list of terms
- * @return boolean False on error, true otherwise
+ * Set the terms for this learnpath item
+ * @param string Terms, as a comma-split list
+ * @return boolean Always return true
*/
function set_terms($terms) {
$lp_item = Database::get_course_table(TABLE_LP_ITEM);
@@ -1957,14 +1977,22 @@ class learnpathItem{
//TODO: validate csv string
$terms_update_sql = "UPDATE $lp_item SET terms = '". Database::escape_string(htmlentities($new_terms_string)) . "' WHERE id=".$this->get_id();
$res = api_sql_query($terms_update_sql,__FILE__,__LINE__);
-
// save it to search engine
if (api_get_setting('search_enabled') == 'true') {
$di = new DokeosIndexer();
- $di->update_terms($this->get_search_id(), $new_terms);
+ $di->update_terms($this->get_search_did(), $new_terms);
}
return true;
}
+ /**
+ * Get the document ID from inside the text index database
+ * @return int Search index database document ID
+ */
+ function get_search_did()
+ {
+ return $this->search_did;
+ }
+
/**
* Sets the item viewing time in a usable form, given that SCORM packages often give it as 00:00:00.0000
* @param string Time as given by SCORM
diff --git a/main/newscorm/lp_controller.php b/main/newscorm/lp_controller.php
index 7a639f9ac4..43ec24f88c 100644
--- a/main/newscorm/lp_controller.php
+++ b/main/newscorm/lp_controller.php
@@ -366,7 +366,7 @@ switch($action)
if(isset($_POST['submit_button']) && !empty($_POST['title']))
{
- $_SESSION['oLP']->edit_item($_GET['id'], $_POST['parent'], $_POST['previous'], $_POST['title'], $_POST['description'], $_POST['prerequisites'], $_POST['terms']);
+ $_SESSION['oLP']->edit_item($_GET['id'], $_POST['parent'], $_POST['previous'], $_POST['title'], $_POST['description'], $_POST['prerequisites']);
if(isset($_POST['content_lp']))
{
@@ -577,21 +577,24 @@ switch($action)
$_SESSION['oLP']->set_name($_REQUEST['lp_name']);
$author= $_REQUEST['lp_author'];
//fixing the author name (no body or html tags)
- if( stripos($author) != 0 ) {
- $len = strripos($author,'')-stripos($author,'