class.ilLuceneIndexer.php

Go to the documentation of this file.

<?php
/* Copyright (c) 1998-2009 ILIAS open source, Extended GPL, see docs/LICENSE */

include_once "Services/Cron/classes/class.ilCronJob.php";

class ilLuceneIndexer extends ilCronJob
{
        protected $timeout = 60;
        
        public function getId()
        {
                return "src_lucene_indexer";
        }
        
        public function getTitle()
        {
                global $lng;
                
                return $lng->txt("cron_lucene_index");
        }
        
        public function getDescription()
        {
                global $lng;
                
                return $lng->txt("cron_lucene_index_info");
        }
        
        public function getDefaultScheduleType()
        {
                return self::SCHEDULE_TYPE_DAILY;
        }
        
        public function getDefaultScheduleValue()
        {
                return;
        }
        
        public function hasAutoActivation()
        {
                return false;
        }
        
        public function hasFlexibleSchedule()
        {
                return true;
        }
        
        public function run()
        {                               
                global $ilSetting;
                
                $status = ilCronJobResult::STATUS_NO_ACTION;            
                $error_message = null;
                
                try
                {
                        include_once './Services/WebServices/RPC/classes/class.ilRpcClientFactory.php';
                        ilRpcClientFactory::factory('RPCIndexHandler',60)->index(
                                CLIENT_ID.'_'.$ilSetting->get('inst_id',0),
                                true
                        );
                }
                catch(Exception $e)
                {
                        $error_message = $e->getMessage();
                        
                        if($e instanceof ilRpcClientException && $e->getCode() == 28)
                        {
                                ilLoggerFactory::getLogger('src')->info('Connection timed out after ' . $this->timeout . ' seconds. '.
                                        'Indexing will continoue without a proper return message. View ilServer log if you think there are problems while indexing.');
                                $error_message = null;
                        }
                        
                }
                
                $result = new ilCronJobResult();
                if($error_message)
                {
                        // #16035 - currently no way to discern the severity of the exception
                        $result->setMessage($error_message);
                        $status = ilCronJobResult::STATUS_FAIL;
                }
                else
                {
                        $status = ilCronJobResult::STATUS_OK;
                }                       
                $result->setStatus($status);            
                return $result;
        }
        
        
        public static function updateLuceneIndex($a_obj_ids)
        {
                global $ilSetting;
                include_once './Services/Search/classes/class.ilSearchSettings.php';
                if(!ilSearchSettings::getInstance()->isLuceneUserSearchEnabled())
                {
                        return false;
                }
                
                try
                {
                        ilLoggerFactory::getLogger('src')->info('Lucene update index call BEGIN --- ');

                        include_once './Services/WebServices/RPC/classes/class.ilRpcClientFactory.php';
                        ilRpcClientFactory::factory('RPCIndexHandler', 1)->indexObjects(
                                CLIENT_ID.'_'.$ilSetting->get('inst_id',0),
                                $a_obj_ids
                        );
                        ilLoggerFactory::getLogger('src')->info('Lucene update index call --- END');
                }
                catch(Exception $e)
                {
                        $error_message = $e->getMessage();
                        ilLoggerFactory::getLogger('src')->error($error_message);
                        return false;
                }

                return true;
        }
        
}

?>