mirror of
https://github.com/moodle/moodle.git
synced 2025-08-05 08:56:36 +02:00
global search review and extension for physical files
This commit is contained in:
diml
parent
cf0b12ac83
commit
2f338ab5b0
28 changed files with 3903 additions and 1485 deletions
|
|
@ -1,15 +1,20 @@
|
|||
<?php
|
||||
/* Index info class
|
||||
*
|
||||
* Used to retrieve information about an index.
|
||||
* Has methods to check for valid database and data directory,
|
||||
* and the index itself.
|
||||
* */
|
||||
/*
|
||||
* Author: Michael Champanis
|
||||
*
|
||||
* Reviewed by: Valery Fremaux (2007)
|
||||
*
|
||||
* Index info class
|
||||
*
|
||||
* Used to retrieve information about an index.
|
||||
* Has methods to check for valid database and data directory,
|
||||
* and the index itself.
|
||||
**/
|
||||
|
||||
require_once("$CFG->dirroot/search/lib.php");
|
||||
require_once("$CFG->dirroot/search/Zend/Search/Lucene.php");
|
||||
require_once("$CFG->dirroot/search/lib.php");
|
||||
require_once("$CFG->dirroot/search/Zend/Search/Lucene.php");
|
||||
|
||||
class IndexInfo {
|
||||
class IndexInfo {
|
||||
private $path, //index data directory
|
||||
$size, //size of directory (i.e. the whole index)
|
||||
$filecount, //number of files
|
||||
|
|
@ -18,193 +23,226 @@
|
|||
$types, //array of [document types => count]
|
||||
$complete, //is index completely formed?
|
||||
$time; //date index was generated
|
||||
|
||||
public function __construct($path=SEARCH_INDEX_PATH) {
|
||||
global $CFG, $db;
|
||||
|
||||
$this->path = $path;
|
||||
|
||||
//test to see if there is a valid index on disk, at the specified path
|
||||
try {
|
||||
$test_index = new Zend_Search_Lucene($this->path, false);
|
||||
$validindex = true;
|
||||
} catch(Exception $e) {
|
||||
$validindex = false;
|
||||
} //catch
|
||||
|
||||
//retrieve file system info about the index if it is valid
|
||||
if ($validindex) {
|
||||
$this->size = display_size(get_directory_size($this->path));
|
||||
$index_dir = get_directory_list($this->path, '', false, false);
|
||||
$this->filecount = count($index_dir);
|
||||
$this->indexcount = $test_index->count();
|
||||
} else {
|
||||
$this->size = 0;
|
||||
$this->filecount = 0;
|
||||
$this->indexcount = 0;
|
||||
} //else
|
||||
|
||||
$db_exists = false; //for now
|
||||
|
||||
//get all the current tables in moodle
|
||||
$admin_tables = $db->MetaTables();
|
||||
|
||||
//TODO: use new IndexDBControl class for database checks?
|
||||
|
||||
//check if our search table exists
|
||||
if (in_array($CFG->prefix.SEARCH_DATABASE_TABLE, $admin_tables)) {
|
||||
//retrieve database information if it does
|
||||
$db_exists = true;
|
||||
|
||||
//total documents
|
||||
$this->dbcount = count_records(SEARCH_DATABASE_TABLE);
|
||||
|
||||
//individual document types
|
||||
$types = search_get_document_types();
|
||||
sort($types);
|
||||
|
||||
foreach($types as $type) {
|
||||
$c = count_records(SEARCH_DATABASE_TABLE, 'doctype', $type);
|
||||
$this->types[$type] = (int)$c;
|
||||
} //foreach
|
||||
} else {
|
||||
$this->dbcount = 0;
|
||||
$this->types = array();
|
||||
} //else
|
||||
|
||||
//check if the busy flag is set
|
||||
if ($CFG->search_indexer_busy == '1') {
|
||||
$this->complete = false;
|
||||
} else {
|
||||
$this->complete = true;
|
||||
} //if
|
||||
|
||||
//get the last run date for the indexer
|
||||
if ($this->valid() && $CFG->search_indexer_run_date) {
|
||||
$this->time = $CFG->search_indexer_run_date;
|
||||
} else {
|
||||
$this->time = 0;
|
||||
} //else
|
||||
|
||||
public function __construct($path = SEARCH_INDEX_PATH) {
|
||||
global $CFG, $db;
|
||||
|
||||
$this->path = $path;
|
||||
|
||||
//test to see if there is a valid index on disk, at the specified path
|
||||
try {
|
||||
$test_index = new Zend_Search_Lucene($this->path, false);
|
||||
$validindex = true;
|
||||
} catch(Exception $e) {
|
||||
$validindex = false;
|
||||
} //catch
|
||||
|
||||
//retrieve file system info about the index if it is valid
|
||||
if ($validindex) {
|
||||
$this->size = display_size(get_directory_size($this->path));
|
||||
$index_dir = get_directory_list($this->path, '', false, false);
|
||||
$this->filecount = count($index_dir);
|
||||
$this->indexcount = $test_index->count();
|
||||
}
|
||||
else {
|
||||
$this->size = 0;
|
||||
$this->filecount = 0;
|
||||
$this->indexcount = 0;
|
||||
}
|
||||
|
||||
$db_exists = false; //for now
|
||||
|
||||
//get all the current tables in moodle
|
||||
$admin_tables = $db->MetaTables();
|
||||
|
||||
//TODO: use new IndexDBControl class for database checks?
|
||||
|
||||
//check if our search table exists
|
||||
if (in_array($CFG->prefix.SEARCH_DATABASE_TABLE, $admin_tables)) {
|
||||
//retrieve database information if it does
|
||||
$db_exists = true;
|
||||
|
||||
//total documents
|
||||
$this->dbcount = count_records(SEARCH_DATABASE_TABLE);
|
||||
|
||||
//individual document types
|
||||
$types = search_get_document_types();
|
||||
sort($types);
|
||||
|
||||
foreach($types as $type) {
|
||||
$c = count_records(SEARCH_DATABASE_TABLE, 'doctype', $type);
|
||||
$this->types[$type] = (int)$c;
|
||||
}
|
||||
}
|
||||
else {
|
||||
$this->dbcount = 0;
|
||||
$this->types = array();
|
||||
}
|
||||
|
||||
//check if the busy flag is set
|
||||
if ($CFG->search_indexer_busy == '1') {
|
||||
$this->complete = false;
|
||||
}
|
||||
else {
|
||||
$this->complete = true;
|
||||
}
|
||||
|
||||
//get the last run date for the indexer
|
||||
if ($this->valid() && $CFG->search_indexer_run_date) {
|
||||
$this->time = $CFG->search_indexer_run_date;
|
||||
}
|
||||
else {
|
||||
$this->time = 0;
|
||||
}
|
||||
} //__construct
|
||||
|
||||
//returns false on error, and the error message via referenced variable $err
|
||||
public function valid(&$err=null) {
|
||||
$err = array();
|
||||
$ret = true;
|
||||
|
||||
if (!$this->is_valid_dir()) {
|
||||
$err['dir'] = 'Index directory either contains an invalid index, or nothing at all.';
|
||||
$ret = false;
|
||||
} //if
|
||||
|
||||
if (!$this->is_valid_db()) {
|
||||
$err['db'] = 'Database table is not present, or contains no index records.';
|
||||
$ret = false;
|
||||
} //if
|
||||
|
||||
if (!$this->complete) {
|
||||
$err['index'] = 'Indexing was not successfully completed, please restart it.';
|
||||
$ret = false;
|
||||
} //if
|
||||
|
||||
return $ret;
|
||||
|
||||
/**
|
||||
* returns false on error, and the error message via referenced variable $err
|
||||
*
|
||||
*/
|
||||
public function valid(&$err = null) {
|
||||
$err = array();
|
||||
$ret = true;
|
||||
|
||||
if (!$this->is_valid_dir()) {
|
||||
$err['dir'] = get_string('invalidindexerror', 'search');
|
||||
$ret = false;
|
||||
}
|
||||
|
||||
if (!$this->is_valid_db()) {
|
||||
$err['db'] = get_string('emptydatabaseerror', 'search');
|
||||
$ret = false;
|
||||
}
|
||||
|
||||
if (!$this->complete) {
|
||||
$err['index'] = get_string('uncompleteindexingerror','search');
|
||||
$ret = false;
|
||||
}
|
||||
|
||||
return $ret;
|
||||
} //valid
|
||||
|
||||
//is the index dir valid
|
||||
|
||||
/**
|
||||
* is the index dir valid
|
||||
*
|
||||
*/
|
||||
public function is_valid_dir() {
|
||||
if ($this->filecount > 0) {
|
||||
return true;
|
||||
} else {
|
||||
return false;
|
||||
} //else
|
||||
if ($this->filecount > 0) {
|
||||
return true;
|
||||
}
|
||||
else {
|
||||
return false;
|
||||
}
|
||||
} //is_valid_dir
|
||||
|
||||
//is the db table valid
|
||||
|
||||
/**
|
||||
* is the db table valid
|
||||
*
|
||||
*/
|
||||
public function is_valid_db() {
|
||||
if ($this->dbcount > 0) {
|
||||
return true;
|
||||
} else {
|
||||
return false;
|
||||
} //else
|
||||
if ($this->dbcount > 0) {
|
||||
return true;
|
||||
}
|
||||
else {
|
||||
return false;
|
||||
}
|
||||
} //is_valid_db
|
||||
|
||||
//shorthand get method for the class variables
|
||||
|
||||
/**
|
||||
* shorthand get method for the class variables
|
||||
*
|
||||
*/
|
||||
public function __get($var) {
|
||||
if (in_array($var, array_keys(get_class_vars(get_class($this))))) {
|
||||
return $this->$var;
|
||||
} //if
|
||||
if (in_array($var, array_keys(get_class_vars(get_class($this))))) {
|
||||
return $this->$var;
|
||||
}
|
||||
} //__get
|
||||
} //IndexInfo
|
||||
} //IndexInfo
|
||||
|
||||
|
||||
/* DB Index control class
|
||||
*
|
||||
* Used to control the search index database table
|
||||
* */
|
||||
/*
|
||||
* DB Index control class
|
||||
*
|
||||
* Used to control the search index database table
|
||||
**/
|
||||
class IndexDBControl {
|
||||
|
||||
class IndexDBControl {
|
||||
//does the table exist?
|
||||
/**
|
||||
* does the table exist?
|
||||
*
|
||||
*/
|
||||
public function checkTableExists() {
|
||||
global $CFG, $db;
|
||||
|
||||
$table = SEARCH_DATABASE_TABLE;
|
||||
$tables = $db->MetaTables();
|
||||
|
||||
if (in_array($CFG->prefix.$table, $tables)) {
|
||||
return true;
|
||||
} else {
|
||||
return false;
|
||||
} //else
|
||||
global $CFG, $db;
|
||||
|
||||
$table = SEARCH_DATABASE_TABLE;
|
||||
$tables = $db->MetaTables();
|
||||
if (in_array($CFG->prefix.$table, $tables)) {
|
||||
return true;
|
||||
}
|
||||
else {
|
||||
return false;
|
||||
}
|
||||
} //checkTableExists
|
||||
|
||||
//is our database setup valid?
|
||||
/**
|
||||
* is our database setup valid?
|
||||
*
|
||||
*/
|
||||
public function checkDB() {
|
||||
global $CFG, $db;
|
||||
global $CFG, $db;
|
||||
|
||||
$sqlfile = "$CFG->dirroot/blocks/search/db/$CFG->dbtype.sql";
|
||||
$ret = false;
|
||||
if ($this->checkTableExists()) {
|
||||
execute_sql('drop table '.$CFG->prefix.SEARCH_DATABASE_TABLE, false);
|
||||
}
|
||||
|
||||
$sqlfile = "$CFG->dirroot/search/db/$CFG->dbtype.sql";
|
||||
$ret = false;
|
||||
//turn output buffering on - to hide modify_database() output
|
||||
ob_start();
|
||||
$ret = modify_database($sqlfile, '', false);
|
||||
|
||||
if ($this->checkTableExists()) {
|
||||
execute_sql('drop table '.$CFG->prefix.SEARCH_DATABASE_TABLE, false);
|
||||
} //if
|
||||
|
||||
ob_start(); //turn output buffering on - to hide modify_database() output
|
||||
$ret = modify_database($sqlfile, '', false);
|
||||
ob_end_clean(); //chuck the buffer and resume normal operation
|
||||
|
||||
return $ret;
|
||||
//chuck the buffer and resume normal operation
|
||||
ob_end_clean();
|
||||
return $ret;
|
||||
} //checkDB
|
||||
|
||||
//add a document record to the table
|
||||
/**
|
||||
* add a document record to the table
|
||||
* @param document must be a Lucene SearchDocument instance
|
||||
*/
|
||||
public function addDocument($document=null) {
|
||||
global $db;
|
||||
|
||||
if ($document == null) {
|
||||
return false;
|
||||
} //if
|
||||
|
||||
//object to insert into db
|
||||
$doc->doctype = $document->doctype;
|
||||
$doc->docid = $document->docid;
|
||||
$doc->title = search_escape_string($document->title);
|
||||
$doc->url = search_escape_string($document->url);
|
||||
$doc->update = time();
|
||||
$doc->docdate = $document->date;
|
||||
$doc->courseid = $document->course_id;
|
||||
$doc->groupid = $document->group_id;
|
||||
|
||||
//insert summary into db
|
||||
$id = insert_record(SEARCH_DATABASE_TABLE, $doc);
|
||||
|
||||
return $id;
|
||||
global $db, $CFG;
|
||||
|
||||
if ($document == null) {
|
||||
return false;
|
||||
}
|
||||
|
||||
// object to insert into db
|
||||
$doc->doctype = $document->doctype;
|
||||
$doc->docid = $document->docid;
|
||||
$doc->itemtype = $document->itemtype;
|
||||
$doc->title = search_escape_string($document->title);
|
||||
$doc->url = search_escape_string($document->url);
|
||||
$doc->update = time();
|
||||
$doc->docdate = $document->date;
|
||||
$doc->courseid = $document->course_id;
|
||||
$doc->groupid = $document->group_id;
|
||||
|
||||
//insert summary into db
|
||||
$id = insert_record(SEARCH_DATABASE_TABLE, $doc);
|
||||
|
||||
return $id;
|
||||
} //addDocument
|
||||
|
||||
//remove a document record from the index
|
||||
/**
|
||||
* remove a document record from the index
|
||||
* @param document must be a Lucene document instance, or at least a dbid enveloppe
|
||||
*/
|
||||
public function delDocument($document) {
|
||||
global $db;
|
||||
|
||||
delete_records(SEARCH_DATABASE_TABLE, 'id', $document->dbid);
|
||||
global $db;
|
||||
|
||||
delete_records(SEARCH_DATABASE_TABLE, 'id', $document->dbid);
|
||||
} //delDocument
|
||||
} //IndexControl
|
||||
} //IndexControl
|
||||
|
||||
?>
|
||||
Loading…
Add table
Add a link
Reference in a new issue