3 # FILE: SPTRecommender.php 5 # Part of the Collection Workflow Integration System (CWIS) 6 # Copyright 2011-2013 Edward Almasy and Internet Scout Research Group 7 # http://scout.wisc.edu/cwis/ 18 # set up recommender configuration values for SPT 19 $ItemTableName =
"Resources";
20 $ItemIdFieldName =
"ResourceId";
21 $RatingTableName =
"ResourceRatings";
22 $UserIdFieldName =
"UserId";
23 $RatingFieldName =
"Rating";
25 # build field info from SPT metadata schema 27 $Fields = $this->Schema->GetFields();
28 foreach ($Fields as $Field)
30 if ($Field->Enabled() && $Field->IncludeInKeywordSearch())
32 $FieldName = $Field->Name();
33 $FieldInfo[$FieldName][
"DBFieldName"] = $Field->DBFieldName();
34 $FieldInfo[$FieldName][
"Weight"] = $Field->SearchWeight();
35 switch ($Field->Type())
41 $FieldInfo[$FieldName][
"FieldType"] =
48 $FieldInfo[$FieldName][
"FieldType"] =
54 $FieldInfo[$FieldName][
"FieldType"] =
59 $FieldInfo[$FieldName][
"FieldType"] =
60 Recommender::CONTENTFIELDTYPE_DATERANGE;
64 $FieldInfo[$FieldName][
"FieldType"] =
69 # (for images we use their alt text) 70 $FieldInfo[$FieldName][
"FieldType"] =
75 # (for files we use the file name) 76 $FieldInfo[$FieldName][
"FieldType"] =
83 # create our own schema object 86 # create a database connection for recommender to use 89 # pass configuration info to real recommender object 90 parent::__construct($DB, $ItemTableName, $RatingTableName,
91 $ItemIdFieldName, $UserIdFieldName, $RatingFieldName,
105 # if resource not already loaded 106 if (!isset($Resources[$ItemId]))
108 # get resource object 109 $Resources[$ItemId] =
new Resource($ItemId);
111 # if cached resource limit exceeded 112 if (count($Resources) > 100)
114 # dump oldest resource 116 list($DumpedItemId, $DumpedResources) = each($Resources);
117 unset($Resources[$DumpedItemId]);
121 # retrieve field value from resource object and return to caller 122 $FieldValue = $Resources[$ItemId]->Get($FieldName);
134 if (is_numeric($ItemOrItemId))
136 $ItemId = $ItemOrItemId;
141 $Item = $ItemOrItemId;
142 $ItemId = $Item->Id();
145 # if no proirity was provided, use the default 146 if ($TaskPriority === NULL)
148 $TaskPriority = self::$TaskPriority;
151 $TaskDescription =
"Update recommender data for" 152 .
" <a href=\"r".$ItemId.
"\"><i>" 153 .$Item->GetMapped(
"Title").
"</i></a>";
154 $GLOBALS[
"AF"]->QueueUniqueTask(array(__CLASS__,
"RunUpdateForItem"),
155 array(intval($ItemId), 0), $TaskPriority, $TaskDescription);
165 # check that resource still exists 167 if (!$RFactory->ItemExists($SourceItemId)) {
return; }
169 # load recommender engine 171 if (!isset($Recommender)) { $Recommender =
new SPTRecommender(); }
173 # if starting update for source item 174 if ($StartingIndex == 0)
176 # clear data for item 177 $Recommender->DropItem($SourceItemId);
180 # load array of item IDs and pare down to those in same schema as source item 181 $TargetItemIds = $Recommender->GetItemIds();
182 $SourceSchemaIds = $RFactory->GetItemIds();
183 $TargetItemIds = array_values(array_intersect(
184 $TargetItemIds, $SourceSchemaIds));
185 $TargetCount = count($TargetItemIds);
187 # while not last item ID and not out of time 188 for ($Index = $StartingIndex; $Index < $TargetCount; $Index++)
190 # if target ID points to non-temporary entry 191 if ($TargetItemIds[$Index] >= 0)
193 # update correlation for source item and current item 194 $StartTime = microtime(TRUE);
195 $Recommender->UpdateContentCorrelation(
196 $SourceItemId, $TargetItemIds[$Index]);
197 $ExecutionTime = microtime(TRUE) - $StartTime;
199 # clear all caches if memory has run low 200 if ($GLOBALS[
"AF"]->GetFreeMemory() < 8000000)
205 if (function_exists(
"gc_collect_cycles"))
211 # bail out if out of memory or not enough time for another update 212 if (($GLOBALS[
"AF"]->GetSecondsBeforeTimeout() < ($ExecutionTime * 2))
213 || ($GLOBALS[
"AF"]->GetFreeMemory() < 8000000))
220 # if all correlations completed for source item 221 if ($Index >= $TargetCount)
223 # periodically prune correlations if enough time remaining 224 if (($GLOBALS[
"AF"]->GetSecondsBeforeTimeout() > 20)
225 && (rand(1, 10) == 1))
227 $Recommender->PruneCorrelations();
232 # requeue updates for remaining items 233 $Item =
new Resource($SourceItemId);
234 $TaskDescription =
"Update recommender data for" 235 .
" <a href=\"r".$SourceItemId.
"\"><i>" 236 .$Item->GetMapped(
"Title").
"</i></a>";
237 $GLOBALS[
"AF"]->QueueUniqueTask(array(__CLASS__,
"RunUpdateForItem"),
238 array((
int)$SourceItemId, $Index),
250 self::$TaskPriority = $NewPriority;
253 # ---- PRIVATE INTERFACE -------------------------------------------------
static Caching($NewSetting=NULL)
Get or set whether query result caching is currently enabled.
const PRIORITY_LOW
Lower priority.
const CONTENTFIELDTYPE_DATE
SQL database abstraction object with smart query caching.
__construct()
SPTRecommender object constructor.
GetFieldValue($ItemId, $FieldName)
Get value for a given field.
const CONTENTFIELDTYPE_NUMERIC
static RunUpdateForItem($SourceItemId, $StartingIndex)
Perform recommender db updates for a specified item (usually in the background)
QueueUpdateForItem($ItemOrItemId, $TaskPriority=NULL)
Queue a background update for a specified item.
const CONTENTFIELDTYPE_TEXT
Represents a "resource" in CWIS.
static SetUpdatePriority($NewPriority)
Set the default priority for background tasks.
Factory for Resource objects.
const PRIORITY_BACKGROUND
Lowest priority.