<?PHP
#
#   FILE:  RSS.php
#
#   Part of the Collection Workflow Integration System (CWIS)
#   Copyright 2011 Internet Scout Project
#   http://scout.wisc.edu
#

# ----- LOCAL FUNCTIONS ------------------------------------------------------

/**
 * Determine if a MetadataField value can be displayed, depending on whether
 * it's enabled and the user has the necessary privileges.
 * @param $Field MetadataField object
 * return TRUE if the field can be displayed, FALSE otherwise
 */
function CanDisplayField(MetadataField $Field=NULL)
{
    global $User;

    # field not set or not enabled
    if (is_null($Field) || !$Field->Enabled())
    {
        return FALSE;
    }

    $ViewingPrivilege = $Field->ViewingPrivilege();

    # insufficient privileges
    if ($ViewingPrivilege === 0 || $User->HasPriv($ViewingPrivilege))
    {
        return FALSE;
    }

    return TRUE;
}

/**
 * Get the value of a metadata field for a resource. The value might be modified
 * by one or more plugins.
 * @param $Resource Resource object
 * @param $Field MetadataField object
 * @return the value of a metadata field for a resource
 */
function GetFieldValue(Resource $Resource, MetadataField $Field)
{
    global $AF;

    $Value = $Resource->Get($Field, TRUE);

    if (is_string($Value))
    {
        $Value = stripslashes($Value);
    }

    # allow plugins to modify the value
    $SignalResult = $AF->SignalEvent(
        "EVENT_FIELD_DISPLAY_FILTER", array(
            "Field" => $Field,
            "Resource" => $Resource,
            "Value" => $Value));
    $Value = $SignalResult["Value"];

    return $Value;
}

/**
 * Get the value of the resource field if it the user can view it and the
 * field is enabled.
 * @param $Resource Resource object
 * @param $Field MetadataField object
 * @return the value of the resource field or "Unavailable" if not available
 */
function GetValueForRss(Resource $Resource, MetadataField $Field)
{
    if (CanDisplayField($Field))
    {
        $Value = strip_tags(GetFieldValue($Resource, $Field));
    }

    else
    {
        $Value = "Unavailable";
    }

    return $Value;
}

/**
 * Get the value from an array with a given index or a default value if it does
 * not exist.
 * @param $Array array
 * @param $Key index of the value to retrieve
 * @param $Default value to return if the value does not exist (defaults to NULL)
 * @return the value at the given index or the default value if it doesn't exist
 */
function GetArrayValue(array $Array, $Key, $Default=NULL)
{
    return (array_key_exists($Key, $Array)) ? $Array[$Key] : $Default;
}

# ----- MAIN -----------------------------------------------------------------

$RSS = new RSS();
$DB = new SPTDatabase();

$DB->Query("SELECT * FROM RSSConfiguration");
$Entry = $DB->FetchRow();

$SiteLink = OurBaseUrl()."index.php?P=Home";
$RssLink = OurBaseUrl()."index.php?P=RSS";
$NumberOfEntriesToPublish = intval($Entry["EntriesToPublish"]);

$RSS->SetEncoding($SysConfig->DefaultCharacterSet());
$RSS->AddChannel(
    $Entry["ChannelTitle"], $SiteLink, $Entry["ChannelDescription"], $RssLink);
$RSS->SetImage(
    $Entry["ImageUrl"], $Entry["ImageHeight"],
    $Entry["ImageWidth"], $Entry["ImageDescription"]);
$RSS->SetLanguage(GetArrayValue($Entry, "Language", NULL));
$RSS->SetCopyright(GetArrayValue($Entry, "CopyRight", NULL));
$RSS->SetManagingEditor(GetArrayValue($Entry, "ManagingEditor", NULL));
$RSS->SetWebmaster(GetArrayValue($Entry, "Webmaster", NULL));
$RSS->SetPicsRating(GetArrayValue($Entry, "PicsRating", NULL));
$RSS->SetPublicationDate(date("Y-n-j"));

# set date of most recent update to resources
$ResourceFact = new ResourceFactory();
$LastChangeTimestamp = $ResourceFact->GetTimestampOfLastResourceModification();
$RSS->SetLastChangeDate(date("Y-m-d", $LastChangeTimestamp));

# if search criteria specified
if (isset($_GET["Q"]) && ($_GET["Q"] == "Y"))
{
    # if saved search is specified
    if (isset($_GET["SI"]) && isset($_GET["UI"]))
    {
        # retrieve search parameters from saved search
        $SFactory = new SavedSearchFactory();
        if ($SFactory->ItemExists($_GET["SI"]))
        {
            $Search = $SFactory->GetItem($_GET["SI"]);
            if ($_GET["UI"] == $Search->UserId())
            {
                $SearchGroups = $Search->SearchGroups();
            }
        }
    }

    # if search parameters not yet set
    if (!isset($SearchGroups))
    {
        # retrieve search parameters from URL
        $SearchGroups = SavedSearch::TranslateUrlParametersToSearchGroups($_GET);
    }

    # set up search engine
    $Engine = new SPTSearchEngine();
    $Engine->SearchTermsRequiredByDefault($SysConfig->SearchTermsRequired());

    # add condition to filter out any temporary resource records
    function FilterOutTempResources($Id) {  return ($Id < 0);  }
    $Engine->AddResultFilterFunction("FilterOutTempResources");

    # add condition to show only released resources
    $Schema = new MetadataSchema();
    $ReleaseField = $Schema->GetFieldByName("Release Flag");
    if ($ReleaseField)
    {
        $SearchGroups[$ReleaseField->Id()]["SearchStrings"]
                ["Release Flag"] = "=1";
        $SearchGroups[$ReleaseField->Id()]["Logic"] = SearchEngine::LOGIC_AND;
    }

    # perform search
    $SearchResults = $Engine->GroupedSearch(
            $SearchGroups, 0, $NumberOfEntriesToPublish,
            "Date of Record Release", 1);

    # load resources
    foreach ($SearchResults as $Id => $Score)
    {
        $Resources[$Id] = new Resource($Id);
    }
}

else
{
    # get resource info to publish
    $Resources = $ResourceFact->GetRecentlyReleasedResources(
            $NumberOfEntriesToPublish, 0, 3650);
}

$Schema = new MetadataSchema();
$TitleField = $Schema->GetFieldByMappedName("Title");
$DescriptionField = $Schema->GetFieldByMappedName("Description");
$DateField = $Schema->GetFieldByName("Date of Record Release");

# add resources to feed
foreach ($Resources as $Resource)
{
    $Title = GetValueForRss($Resource, $TitleField);
    $Description = GetValueForRss($Resource, $DescriptionField);
    $Date = GetValueForRss($Resource, $DateField);
    $Url = OurBaseUrl()."index.php?P=FullRecord&ResourceId=".$Resource->Id();

    $RSS->AddItem($Title, $Url, $Description, $Date);
}

# suppress HTML output and publish RSS page
$AF->SuppressHTMLOutput();
$RSS->PrintRSS();
