calendar_event.inc

<?php
require_once SQ_INCLUDE_PATH.'/asset.inc';
require_once SQ_FUDGE_PATH.'/datetime_field/datetime_field.inc';
require_once SQ_FUDGE_PATH.'/general/datetime.inc';
require_once dirname(__FILE__).'/../lib/calendar_common.inc';

class Calendar_Event extends Asset
{


    function Calendar_Event($assetid=0)
    {
        $this->Asset($assetid);

    }//end constructor


    function _preCreateCheck(&$link)
    {
        if (!parent::_preCreateCheck($link)) return FALSE;

        $name = $this->attr('name');
        if ($GLOBALS['SQ_SYSTEM']->runLevelEnables(SQ_SECURITY_INTEGRITY) && ($name == '')) {
            trigger_localised_error('CAL0008', E_USER_WARNING, $GLOBALS['SQ_SYSTEM']->am->getTypeInfo($this->type(), 'name'));
            return FALSE;
        }

        return TRUE;

    }//end _preCreateCheck()


    function _createAdditional(&$link)
    {
        if (!parent::_createAdditional($link)) return FALSE;
        $result = $this->cacheCalendarData(FALSE);
        // set an initial web path
        $initial_path = strtolower($this->attr('name'));
        require_once SQ_INCLUDE_PATH.'/general_occasional.inc';
        $valid_paths = make_valid_web_paths(Array($initial_path));
        $good_paths = $GLOBALS['SQ_SYSTEM']->am->webPathsInUse($link['asset'], $valid_paths, $this->id, TRUE);
        $result_paths = $this->saveWebPaths($good_paths);
        return ($result && $result_paths);

    }//end _createAdditional()


    function delete($release_lock=TRUE)
    {
        $GLOBALS['SQ_SYSTEM']->changeDatabaseConnection('db2');
        $db = MatrixDAL::getDb();
        $GLOBALS['SQ_SYSTEM']->doTransaction('BEGIN');

        try {
            $bind_vars  = Array (
                            'assetid'   => $this->id,
                          );
            $result = MatrixDAL::executeQuery('calendar_event', 'deleteCalendarEvent', $bind_vars);
        } catch (Exception $e) {
            throw new Exception('Unable to delete the eventid #:'.$this->id.' from the trash due to the following database error:'.$e->getMessage());
        }//end try catch

        if (!parent::delete($release_lock)) {
            $GLOBALS['SQ_SYSTEM']->doTransaction('ROLLBACK');
            $GLOBALS['SQ_SYSTEM']->restoreDatabaseConnection();
            return FALSE;
        }

        $GLOBALS['SQ_SYSTEM']->doTransaction('COMMIT');
        $GLOBALS['SQ_SYSTEM']->restoreDatabaseConnection();
        return TRUE;

    }//end delete()


    protected function _getName($short_name=FALSE, $contextid=NULL)
    {
        // No context specified, using the current context
        if ($contextid === NULL) {
            $contextid = $GLOBALS['SQ_SYSTEM']->getContextId();
        }//end if

        // Obtain the attribute value for Name from the specified Context
        $values = $GLOBALS['SQ_SYSTEM']->am->getAttributeValuesByName('name', $this->type(), Array($this->id), $contextid);
        if (empty($values) === TRUE) {
            return parent::_getName($short_name, $contextid);
        } else {
            return $values[$this->id];
        }

    }//end _getName()


    function getAvailableKeywords()
    {
        $keywords = parent::getAvailableKeywords();

        $our_keywords = Array();
        $our_keywords[] = 'asset_attribute_start_date'; // = translate('start_date_iso'); //'Start date (iso8601)';
        $our_keywords[] = 'asset_attribute_end_date'; // = translate('end_date_iso'); //'End date (iso8601)';
        $our_keywords[] = 'event_start_date'; // = translate('start_date_only_readable'); //'Event Start Date';
        $our_keywords[] = 'event_end_date'; // = tralsate('end_date_only_readable'); //'Event End Date';
        $our_keywords[] = 'event_start_datetime'; // = translate('Event start date/time';
        $our_keywords[] = 'event_end_datetime'; // = 'Event end date/time';
        $our_keywords[] = 'event_start_time_12h'; // = 'Start time (12 hour)';
        $our_keywords[] = 'event_end_time_12h'; // = 'End time (12 hour)';
        $our_keywords[] = 'event_start_time_24h'; // = 'Start time (24 hour)';
        $our_keywords[] = 'event_end_time_24h'; // = 'End time (24 hour)';
        $our_keywords[] = 'event_short_start_time'; // = 'Short start time (12 hour)';
        $our_keywords[] = 'event_short_end_time'; // = 'Short end time (12 hour)';
        $our_keywords[] = 'event_start_time_ical'; // = 'Start time (iCalendar)';
        $our_keywords[] = 'event_end_time_ical'; // = 'End time (iCalendar)';
        $our_keywords[] = 'event_datetime_summary'; // = 'Friendly description of event dates and times';
        $our_keywords[] = 'event_duration'; // = 'Duration of the Event';
        $our_keywords[] = 'edit_link'; // = 'Link to edit this event in Limbo (if user has permission)';
        $our_keywords[] = 'delete_link'; // = 'Link to delete this event altogether (if user has permission)';
        $our_keywords[] = 'event_start_datetime_'; // = dynamic keyword to print start date and time
        $our_keywords[] = 'event_end_datetime_'; // = dynamic keyword to print end date and time
        $our_keywords[] = 'event_calendar_date_'; // = dynamic keyword to print calendar date


        foreach ($our_keywords as $keyword) {
            $keywords[$keyword] = translate('cal_evt_keyword_'.$keyword);
        }

        return $keywords;

    }//end getAvailableKeywords()


    function _getAllowedLinks()
    {
        return Array(
                SQ_LINK_TYPE_1  => Array(
                                    'file'  => Array('card' => 'M', 'exclusive' => FALSE),
                                    'page'  => Array('card' => 'M', 'exclusive' => FALSE),
                                   ),
                SQ_LINK_TYPE_2  => Array(
                                    'file'  => Array('card' => 'M', 'exclusive' => FALSE),
                                    'page'  => Array('card' => 'M', 'exclusive' => FALSE),
                                   ),
                SQ_LINK_TYPE_3  => Array(),
                SQ_LINK_NOTICE  => Array(
                                    'image'             => Array('card' =>   1, 'exclusive' => FALSE),
                                    'design'            => Array('card' => 'M', 'exclusive' => FALSE),
                                    'paint_layout_page' => Array('card' => 'M', 'exclusive' => FALSE),
                                   ),
               );

    }//end _getAllowedLinks()


    function _getDeleteLink()
    {
        if (TRUE === ($msg = $GLOBALS['SQ_SYSTEM']->am->couldTrashAsset($this->id))) {
            $res = '<a href="?SQ_CALENDAR_EVENT_ID='.$this->id.'&amp;SQ_CALENDAR_EVENT_ACTION=delete';
            if (isset($_REQUEST['SQ_CALENDAR_DATE'])) {
                $res .= '&amp;SQ_CALENDAR_DATE='.$_REQUEST['SQ_CALENDAR_DATE'];
            }
            $res .= '" onclick="return confirm(js_translate(\'confirm_delete_event\'));">'.translate('delete').'</a>';
            return $res;
        } else {
            return '';
        }

    }//end _getDeleteLink()


    function saveAttributes($dont_run_updated=FALSE)
    {
        $start_date = $this->attr('start_date');
        $end_date   = $this->attr('end_date');

        // work out if we have any 'null date' or 'null time' sections
        $start_has_time = $this->getStartTime();
        $end_has_time   = $this->getEndTime();
        $start_has_date = $this->getStartDate();
        $end_has_date   = $this->getEndDate();

        if ($GLOBALS['SQ_SYSTEM']->runLevelEnables(SQ_SECURITY_INTEGRITY)) {

            // All events must have a starting date at least!
            if (!$start_has_date) {
                trigger_localised_error('CAL0009', E_USER_WARNING);
                return FALSE;
            }

            // cannot have End Date being like '---------- 11:00:00'
            if (!$end_has_date && $end_has_time) {
                trigger_localised_error('CAL0010', E_USER_WARNING);
                return FALSE;
            }

            // Cannot have an end time if you have no start time
            if ($end_has_time && (!$start_has_time)) {
                trigger_localised_error('CAL0011', E_USER_WARNING);
                return FALSE;
            }

            // Cannot have an end date and start time if you have no end time
            if ($end_has_date && $start_has_time && (!$end_has_time)) {
                trigger_localised_error('CAL0012', E_USER_WARNING);
                return FALSE;
            }

            // If an End Date is specified (and we need date component so we can use that to check),
            // the End Date must be no earlier than the start Date
            if ($end_has_date) {
                if (iso8601_ts($end_date) < iso8601_ts($start_date)) {
                    trigger_localised_error('CAL0013', E_USER_WARNING, $GLOBALS['SQ_SYSTEM']->am->getTypeInfo($this->type(), 'name'));
                    return FALSE;
                }
            }

        }//end if

        // oh no, we're not using this to display anything... just to use its units extraction :-)
        $params = Array();
        $value = '';
        $datetime = new Datetime_Field('', $value, $params);

        // check individual sections to make sure we can't commit part dates like '16th, 2005 48'
        $start_components = $datetime->strToUnitsArray($start_date);
        $end_components = $datetime->strToUnitsArray($end_date);

        // don't need to check Start Date's date component as it is required!
        // must check other parts of both Start and End Date so a meaningful date is stored

        // For dates, this means all three parts of the date have a value
        if ($end_has_date && (($end_components['d'] == -1) || ($end_components['m'] == -1) || ($end_components['y'] == -1))) {
            trigger_localised_error('CAL0014', E_USER_WARNING);
            return FALSE;
        }

        // For times, at least hour and minute must be specified. You can get away with not specifying
        // seconds, it's optional.
        if ($start_has_time && (($start_components['h'] == -1) || ($start_components['i'] == -1))) {
            trigger_localised_error('CAL0015', E_USER_WARNING);
            return FALSE;
        }

        if ($end_has_time && (($end_components['h'] == -1) || ($end_components['i'] == -1))) {
            trigger_localised_error('CAL0016', E_USER_WARNING);
            return FALSE;
        }

        // cache all the calendar data into another table so the queries for the calendar
        // page go super-mega-hyperturbo (but only if already created)
        if (!empty($this->id) && !$dont_run_updated) {
            if (!$this->cacheCalendarData()) return FALSE;
        }
        $treeid = Array();

        // bug fix #5364 Recurring Calendar Event: Time Changes don't get sent to child Event Modifications
        // we need to make ssure to cascade the changes to and children of the recurring event,if thats the
        // asset type we are updating.
        // also make sure "THIS" asset does have the valid treeid before we try to get its children
        if ($this->id) $treeid = $GLOBALS['SQ_SYSTEM']->am->getAssetTreeids($this->id);
        if (($this->id) && $this->type() == 'calendar_event_recurring' && $GLOBALS['SQ_SYSTEM']->runLevelEnables(SQ_SECURITY_INTEGRITY) && !empty($treeid)) {
            $events_to_update = $GLOBALS['SQ_SYSTEM']->am->getChildren($this->id, 'calendar_event_modification');
            // because we do not have locks on the child modofication assets
            // we need to set the run level so that we can update these assets
            $GLOBALS['SQ_SYSTEM']->setRunLevel(SQ_RUN_LEVEL_FORCED);
            foreach ($events_to_update as $event_id => $info) {
                $modification_event = $GLOBALS['SQ_SYSTEM']->am->getAsset($event_id);
                if (!$modification_event->saveAttributes()) {
                    $GLOBALS['SQ_SYSTEM']->restoreRunLevel();
                    return FALSE;
                }
            }
            $GLOBALS['SQ_SYSTEM']->restoreRunLevel();
        }

        // all sweet, so it seems
        return parent::saveAttributes($dont_run_updated);

    }//end saveAttributes()


    function cloneComponents(&$clone, $components, $override=FALSE)
    {
        $GLOBALS['SQ_SYSTEM']->changeDatabaseConnection('db2');
        $GLOBALS['SQ_SYSTEM']->doTransaction('BEGIN');

        if (!parent::cloneComponents($clone, $components, $override)) {
            $GLOBALS['SQ_SYSTEM']->doTransaction('ROLLBACK');
            $GLOBALS['SQ_SYSTEM']->restoreDatabaseConnection();
            return FALSE;
        }

        if (in_array('all', $components) || in_array('attributes', $components)) {
            if (!$clone->cacheCalendarData(FALSE)) {
                $GLOBALS['SQ_SYSTEM']->doTransaction('ROLLBACK');
                $GLOBALS['SQ_SYSTEM']->restoreDatabaseConnection();
                return FALSE;
            }
        }

        $GLOBALS['SQ_SYSTEM']->doTransaction('COMMIT');
        $GLOBALS['SQ_SYSTEM']->restoreDatabaseConnection();
        return TRUE;

    }//end cloneComponents()


    function getStartDate()
    {
        $res = substr($this->attr('start_date'), 0, 10);
        return ($res == '----------') ? FALSE : $res;

    }//end getStartDate()


    function getEndDate()
    {
        $res = substr($this->attr('end_date'), 0, 10);
        return ($res == '----------') ? FALSE : $res;

    }//end getEndDate()


    function getStartTime()
    {
        $res = substr($this->attr('start_date'), 11, 5);
        return ($res == '--:--') ? FALSE : $res;

    }//end getStartTime()


    function getEndTime()
    {
        $res = substr($this->attr('end_date'), 11, 5);
        return ($res == '--:--') ? FALSE : $res;

    }//end getEndTime()


    function getDuration()
    {
        $seconds_per_day = 24 * 60 * 60;

        $start_date = $this->attr('start_date');
        $end_date   = $this->attr('end_date');

        // work out if we have any 'null date' or 'null time' sections
        $start_has_time = $this->getStartTime();
        $end_has_time   = $this->getEndTime();
        $start_has_date = $this->getStartDate();
        $end_has_date   = $this->getEndDate();

        if (!$start_has_date) return NULL;

        if (!$end_has_date) {
            // single point in time, and so it has no duration
            return 0;
        }

        // NOTE: no need to replace null time fields with 'midnight' (00:00:00) because the
        // ISO-to-timestamp conversion function already recognises that it's not a full datetime
        // if that's the case

        if (!$start_has_time && !$end_has_time) {
            // in a multiple day event without times it's assumed to be the start of the start date
            // (ie. 00:00) to the end of the end date (ie. 00:00 the day after end date).
            return iso8601_ts($end_date) - iso8601_ts($start_date) + $seconds_per_day;

        } else {
            // all fields specified, from one time point to another
            return iso8601_ts($end_date) - iso8601_ts($start_date);

        }

    }//end getDuration()


    function getFriendlyStart()
    {
        if ($this->getStartTime() !== FALSE) {
            return readable_datetime(iso8601_ts($this->attr('start_date')));
        } else {
            return date('jS M Y', iso8601_ts($this->attr('start_date')));
        }

    }//end getFriendlyStart()


    function getFriendlyEnd()
    {
        if ($this->getEndTime() !== FALSE) {
            return readable_datetime(iso8601_ts($this->attr('end_date')));
        } else if (iso8601_ts($this->attr('end_date')) == -1) {
            return '';
        } else {
            return date('jS M Y', iso8601_ts($this->attr('end_date')));
        }

    }//end getFriendlyEnd()


    function getFriendlyDatesAndTimes()
    {
        if (substr($this->attr('start_date'), 0, 10) == substr($this->attr('end_date'), 0, 10)) {
            // start and end dates are the same
            if (!$this->getStartTime()) {
                // no start time, so must be an all day event
                return $this->getFriendlyStart().' (all day)';
            } else if (($this->getStartTime() == $this->getEndTime())) {
                // show start date and time only
                return $this->getFriendlyStart();
            } else {
                // show date and start/end times
                return $this->getFriendlyStart().'-'.date('g:ia', iso8601_ts($this->attr('end_date')));
            }
        } else if (iso8601_ts($this->attr('end_date')) == -1) {
            return $this->getFriendlyStart();
        } else {
            return $this->getFriendlyStart().' - '.$this->getFriendlyEnd();
        }

    }//end getFriendlyDatesAndTimes()


    function printBody()
    {
        require_once SQ_FUDGE_PATH.'/general/datetime.inc';
        ?>
        <table border="0" cellspacing="2" cellpadding="2">
            <tr>
                <td><b>Event Name</b></td>
                <td><?php echo $this->attr('name'); ?></td>
            </tr>
            <tr>
                <td><b>Start Date</b></td>
                <td><?php echo $this->getFriendlyStart(); ?></td>
            </tr>
            <tr>
                <td><b>End Date</b></td>
                <td><?php echo $this->getFriendlyEnd(); ?></td>
            </tr>
            <tr>
                <td><b>Duration</b></td>
                <td><?php
                        // give useful info if no duration - easy_time_total returns empty string
                        $total_time = easy_time_total($this->getDuration(), TRUE);
                        echo (empty($total_time) ? 'N/A' : $total_time);
                    ?></td>
            </tr>
            <tr>
                <td><b>Description</b></td>
                <td><?php echo $this->getKeywordReplacement('asset_attribute_description'); ?></td>
            </tr>
        </table>
        <?php

    }//end printBody()


    function processEventAction($action_name)
    {
        switch ($action_name) {
            case 'move':
                if (isset($_REQUEST['SQ_CALENDAR_OLD_LOC']) && !empty($_REQUEST['SQ_CALENDAR_OLD_LOC'])) {
                    $old_link = $GLOBALS['SQ_SYSTEM']->am->getLinkByAsset($_REQUEST['SQ_CALENDAR_OLD_LOC'], $this->id);
                    if (empty($old_link)) {
                        trigger_localised_error('CAL0017', E_USER_WARNING, $_REQUEST['SQ_CALENDAR_OLD_LOC'], $this->id);
                        return '';
                    }
                    if (!$GLOBALS['SQ_SYSTEM']->am->moveLink($old_link['linkid'], $_REQUEST['SQ_CALENDAR_NEW_LOC'], $old_link['link_type'], -1)) {
                        trigger_localised_error('CAL0018', E_USER_WARNING, $_REQUEST['SQ_CALENDAR_OLD_LOC'], $_REQUEST['SQ_CALENDAR_NEW_LOC']);
                        return '';
                    }
                }
                if (!isset($_REQUEST['SQ_CALENDAR_NEW_DATE'])) {
                    trigger_localised_error('CAL0019', E_USER_WARNING);
                    return '';
                }
                $duration = $this->getDuration();
                if (!isset($_REQUEST['SQ_CALENDAR_NEW_TIME']) || empty($_REQUEST['SQ_CALENDAR_NEW_TIME'])) {
                    $_REQUEST['SQ_CALENDAR_NEW_TIME'] = '--:--';
                }
                $this->setAttrValue('start_date', $_REQUEST['SQ_CALENDAR_NEW_DATE'].' '.$_REQUEST['SQ_CALENDAR_NEW_TIME'].':--');
                $current_end_date = $this->getEndDate();
                if ($current_end_date) {
                    $new_end_date_ts = iso8601_ts($this->attr('start_date')) + $duration;
                    $new_end_date = date('Y-m-d', $new_end_date_ts);
                    $new_end_time = $this->getEndTime() ? date('H:i:00', $new_end_date_ts) : '--:--:--';
                    $this->setAttrValue('end_date', $new_end_date.' '.$new_end_time);
                }
                if (!$GLOBALS['SQ_SYSTEM']->am->acquireLock($this->id, 'attributes')) {
                    trigger_localised_error('CAL0020', E_USER_WARNING, $this->name, $this->id);
                    return '';
                }
                $this->saveAttributes();
                $GLOBALS['SQ_SYSTEM']->am->releaseLock($this->id, 'attributes');
            break;

            case 'delete':
                $GLOBALS['SQ_SYSTEM']->am->trashAsset($this->id);
                $this->updateLookups();
            break;

            default:
                trigger_localised_error('CAL0021', E_USER_WARNING, $action_name);
                return '';
            break;
        }//end switch

    }//end processEventAction()


    function cacheCalendarData($updating=TRUE)
    {
        $GLOBALS['SQ_SYSTEM']->changeDatabaseConnection('db2');
        $db = MatrixDal::getDb();

        $date_values = Array();

        foreach (Array('start_date', 'end_date') as $date_comp) {
            $iso = $this->attr($date_comp);

            if (iso8601_time_component($iso) === FALSE) {
                if (($date_comp == 'end_date') && (iso8601_date_component($iso) !== FALSE)) {
                    $iso = substr($iso, 0, 10).' 24:00:00';
                }
            } else {
                // we know the seconds aren't going to be there, so zero them so we can
                // use the getDate() niceness
                $iso = substr($iso, 0, 16).':00';
            }

            // we have the best, now get the rest
            $date_values += Calendar_Common::getDateComponents($iso, $date_comp.'_');
        }

        // frequency field => blank for standard events, overridden in recurring
        $date_values['frequency'] = '';

        $GLOBALS['SQ_SYSTEM']->doTransaction('BEGIN');

        if (!$updating) {
            // set the asset ids
            $date_values['assetid'] = $this->id;

            for (reset($date_values); NULL !== ($key = key($date_values)); next($date_values)) {
                if (is_null($date_values[$key]))
                    $date_values[$key] = 'NULL';
                else
                $date_values[$key] = MatrixDAL::quote($date_values[$key]);
            }
            $val_string = implode(',', $date_values);

            $sql = 'INSERT INTO
                        sq_cal_date_val
                        (
                            '.implode(',', array_keys($date_values)).'
                        )
                        VALUES
                        (
                            '.$val_string.'
                        )';

            try {
                $query = MatrixDAL::preparePdoQuery($sql);
                MatrixDAL::execPdoQuery($query);
            } catch (Exception $e) {
                throw new Exception($e->getMessage());
            }
        } else {
            // asset id becomes a where condition
            $sql = 'UPDATE
                        sq_cal_date_val
                    SET ';

            $set_array = Array();
            foreach ($date_values as $key => $value) {
                $set_array[] = $key.' = '.((is_null($value)) ? 'null' : MatrixDAL::quote($value));
            }
            $sql .= implode(',', $set_array);
            $sql .=' WHERE
                        assetid = :assetid';

            try {
                $query = MatrixDAL::preparePdoQuery($sql);
                MatrixDAL::bindValueToPdo($query, 'assetid', $this->id);
                MatrixDAL::execPdoQuery($query);
            } catch (Exception $e) {
                throw new Exception($e->getMessage());
            }
        }

        $GLOBALS['SQ_SYSTEM']->doTransaction('COMMIT');
        $GLOBALS['SQ_SYSTEM']->restoreDatabaseConnection();

        return TRUE;

    }//end cacheCalendarData()


    function getKeywordReplacement($keyword)
    {
        $end_date_not_set = ($this->getEndDate() === FALSE);
        $start_time_not_set = ($this->getStartTime() === FALSE);
        $end_time_not_set = ($this->getEndTime() === FALSE);

        $keyword = parse_keyword($keyword, $modifiers);

        switch ($keyword) {
            case 'event_name':
                $replacement = $this->name;
                break;

            case 'event_start_date':
                $replacement = date('jS M Y', iso8601_ts($this->attr('start_date')));
                break;

            case 'event_start_time_12h':
                $replacement = $start_time_not_set ? '' : date('h:i a', iso8601_ts($this->attr('start_date')));
                break;

            case 'event_start_time_24h':
                $replacement = $start_time_not_set ? '' : date('H:i', iso8601_ts($this->attr('start_date')));
                break;

            case 'event_start_time_ical':
                // If theres no time bit, then only use the date portion to get the correct iCal timestamp
                if (preg_match("/^(.*?) (--):(--):(--)$/", $this->attr('start_date'))) {
                    $replacement = date('Ymd', iso8601_ts($this->attr('start_date')));
                } else {
                    $replacement = date('Ymd\THis', iso8601_ts($this->attr('start_date')));
                }
                break;

            case 'event_end_date':
                // In the case of 'end_date' of the first instance is not set
                $replacement = $end_date_not_set ? '' : date('jS M Y', iso8601_ts($this->attr('end_date')));
                break;

            case 'event_end_time_12h':
                $replacement = $end_time_not_set ? '' : date('h:i a', iso8601_ts($this->attr('end_date')));
                break;

            case 'event_end_time_24h':
                $replacement = $end_time_not_set ? '' : date('H:i', iso8601_ts($this->attr('end_date')));
                break;

            case 'event_short_start_time':
                if ($start_time_not_set) {
                    $replacement = '';
                } else {
                    $mins = date('i', iso8601_ts($this->attr('start_date')));
                    if ($mins == '00') {
                        $replacement = date('ga', iso8601_ts($this->attr('start_date')));
                    } else {
                        $replacement = date('g:ia', iso8601_ts($this->attr('start_date')));
                    }
                }
                break;

            case 'event_short_end_time':
                if ($start_time_not_set) {
                    $replacement = '';
                } else {
                    $mins = date('i', iso8601_ts($this->attr('end_date')));
                    if ($mins == '00') {
                        $replacement = date('ga', iso8601_ts($this->attr('end_date')));
                    } else {
                        $replacement = date('g:ia', iso8601_ts($this->attr('end_date')));
                    }
                }
                break;

            case 'event_end_time_ical':
                if ($end_date_not_set) {
                    $replacement = '';
                } else {
                    // If theres no end time for given end date then accourding to iCal
                    // standards this means end date is next day without time bit but
                    // this is confusing and misleading for the users so as a fix to
                    // issue reported on #5359 iCal date keyword prints incorrected if
                    // end date has no time, we will let the end date be according to
                    // hCalendar standards. More information on bug report's comments
                    $no_endtime_pattern = "/^(....)-(..)-([0-9]{2}) (--:--:--)$/";
                    $replacement = "$1-$2-$3";
                    if (preg_match($no_endtime_pattern, $this->attr('end_date'), $matches)) {
                        $end_date = preg_replace($no_endtime_pattern, $replacement, $this->attr('end_date'));
                    } else {
                        $end_date = $this->attr('end_date');
                    }

                    // Don't worry about possibility of invalid date resulting from incrementing
                    // the day bit above; php's date() will handle it correctly
                    $replacement = preg_match("/..:..:..$/",$end_date) ? date('Ymd\THis', iso8601_ts($end_date)) : date('Ymd', iso8601_ts($end_date));
                }
                break;

            case 'event_start_datetime':
                $replacement = $this->getFriendlyStart();
                break;

            case 'event_end_datetime':
                $replacement = $this->getFriendlyEnd();
                break;

            case 'event_datetime_summary':
                $replacement = $this->getFriendlyDatesAndTimes();
                break;

            case 'event_duration':
                // give useful info if no duration (single point in time) - easy_time_total returns empty string
                $total_time = easy_time_total($this->getDuration(), TRUE);
                if (empty($total_time)) $total_time = 'N/A';
                $replacement = $total_time;
                break;

            case 'edit_link':
                $replacement = $this->writeAccess('') ? '<a href="'.htmlentities(replace_query_string_vars(Array('SQ_CALENDAR_VIEW'=>'edit', 'SQ_CALENDAR_EVENT_ID'=>$this->id))).'">'.translate('cal_event_edit_link_text').'</a>' : '';
                break;

            case 'delete_link':
                $replacement = $this->_getDeleteLink();
                break;

            case 'instance_start_datetime':

                $start_ts = isset($this->vars['start_date_ts']) ? $this->attr('start_date_ts') : '';
                if (!empty($start_ts)) {
                    $replacement = date('Y-m-d H:i', $start_ts);
                }
                break;

            case 'instance_end_datetime':
                $end_ts = isset($this->vars['end_date_ts']) ? $this->attr('end_date_ts') : '';
                if (!empty($end_ts)) {
                    $replacement = empty($end_ts) ? '' : date('Y-m-d H:i', $end_ts);
                }
                break;

            default:
                // if the keyword at this point starts with event_start_datetime_ or event_end_datetime_
                // it means this is a dynamic keyword to display a date
                preg_match('/^event_start_datetime_(.+)/', $keyword, $matches);
                if (!empty($matches)) {
                    $replacement = date($matches[1], iso8601_ts($this->attr('start_date')));
                }
                preg_match('/^event_end_datetime_(.+)/', $keyword, $matches);
                if (!empty($matches)) {
                    $replacement = $end_date_not_set ? '' : date($matches[1], iso8601_ts($this->attr('end_date')));
                }

                preg_match('/^event_calendar_date_(.+)/', $keyword, $matches);
                if (!empty($matches) && !empty($_REQUEST['SQ_CALENDAR_DATE'])) {
                    $replacement = date($matches[1], strtotime($_REQUEST['SQ_CALENDAR_DATE']));
                }

                // Event instance keywords
                if (isset($this->vars['start_date_ts'])) {
                    $start_ts = $this->attr('start_date_ts');
                    preg_match('/^instance_start_datetime_(.+)/', $keyword, $matches);
                    if (!empty($matches)) {
                        if ($matches[1] == 'ical') {
                            $replacement = empty($start_ts) ? '' : date('Ymd\THis', $start_ts);
                        } else {
                            $replacement = empty($start_ts) ? '' : date($matches[1], $start_ts);
                        }
                    }//end if
                }
                if (isset($this->vars['end_date_ts'])) {
                    $end_ts = $this->attr('end_date_ts');
                    preg_match('/^instance_end_datetime_(.+)/', $keyword, $matches);
                    if (!empty($matches)) {
                        if ($matches[1] == 'ical') {
                            $replacement = empty($end_ts) ? '' : date('Ymd\THis', $end_ts);
                        } else {
                            $replacement = empty($end_ts) ? '' : date($matches[1], $end_ts);
                        }
                    }//end if
                }

                if (empty($replacement)) $replacement = parent::getKeywordReplacement($keyword);
                break;

        }//end switch

        apply_keyword_modifiers($replacement, $modifiers, Array('assetid' => $this->id));

        return $replacement;

    }//end getKeywordReplacement()


    public function getAsset($whole_assetid)
    {
        $asset = NULL;
        $assetid_parts = explode(':', $whole_assetid);

        $assetid = $assetid_parts[0];
        if (empty($assetid_parts[1])) {
            return $asset;
        } else {
            $shdw_part_data = explode(',', $assetid_parts[1]);
            $instance_data = Array();
            foreach($shdw_part_data as $data) {
                list($key, $val) = explode("=", $data);
                $instance_data[$key] = $val;
            }
            if (!$GLOBALS['SQ_SYSTEM']->am->getAssetInfo($assetid)) {
                return $asset;
            }
            $event_asset = clone $GLOBALS['SQ_SYSTEM']->am->getAsset($assetid);

            $event_asset->full_id = $whole_assetid;
            foreach($instance_data as $attr => $value) {
                $event_asset->vars[$attr]['attrid'] = 0;
                $event_asset->vars[$attr]['type'] = 'text';
                $event_asset->vars[$attr]['value'] = $value;
                $event_asset->vars[$attr]['is_contextable'] = 0;
            }
        }

        return $event_asset;

    }//end getAsset()


    public function getAssetInfo(Array $assetids, $type_code=Array(), $strict_type_code=TRUE, $field='')
    {
        $info = Array();
        foreach ($assetids as $whole_assetid) {
            $assetid_parts = explode(':', $whole_assetid);
            $assetid = $assetid_parts[0];
            if (empty($assetid_parts[1])) {
                $asset_type = $this->type();
            } else {
                $event_data_raw = explode(',', $assetid_parts[1]);
                $event_data = Array();
                foreach($event_data_raw as $event) {
                    list($key, $val) = explode("=", $event);
                    $event_data[$key] = $val;
                }
                $asset_type = $event_data['type_code'];
            }

            $asset = $GLOBALS['SQ_SYSTEM']->am->getAsset($assetid);
            // if a sort field is specified then return only that field value else return all of the fields
            if (!empty($field)) {
                if (isset($event_data[$field])) {
                    $info[$whole_assetid] = $event_data[$field];
                } else if (isset($asset->{$field})) {
                    $info[$whole_assetid] = $asset->{$field};
                } else {
                    trigger_error('Invalid field for the asset type Calendar Event asset', E_USER_ERROR);
                }
            } else {
                $info[$whole_assetid] = Array(
                                    'type_code'             => $asset_type,
                                    'version'               => $asset->version,
                                    'name'                  => $asset->name,
                                    'short_name'            => $asset->short_name,
                                    'status'                => $asset->status,
                                    'languages'             => '',
                                    'charset'               => '',
                                    'force_secure'          => '0',
                                    'created'               => $asset->getKeywordReplacement('asset_created'),
                                    'created_userid'        => $asset->created_userid,
                                    'updated'               => $asset->getKeywordReplacement('asset_updated'),
                                    'updated_userid'        => $asset->updated_userid,
                                    'published'             => $asset->getKeywordReplacement('asset_published'),
                                    'published_userid'      => $asset->published_userid,
                                    'status_changed'        => $asset->getKeywordReplacement('asset_status_changed'),
                                    'status_changed_userid' => $asset->status_changed_userid,
                                  );
            }//end if field not empty
        }//end foreach of assetids

        return $info;

    }//end getAssetInfo()

    
    public function getAttributeValuesByName($attr_name, $asset_type, $assetids, $contextid=NULL)
    {
        if (empty($assetids)) return Array();
        
        $real_assetids = Array();
        foreach($assetids as $full_assetid) {
            if (strpos($full_assetid, ':') !== FALSE) {
                list($real_assetids[]) = explode(':', $full_assetid);
            } else {
                $real_assetids[] = $full_assetid;
            }
        }//end foreach
        
        $real_res = $GLOBALS['SQ_SYSTEM']->am->getAttributeValuesByName($attr_name, $asset_type, $real_assetids, $contextid);
        
        $res = Array();
        foreach($assetids as $full_assetid) {
            list($real_assetid) = explode(':', $full_assetid);
            $res[$full_assetid] = isset($real_res[$real_assetid]) ? $real_res[$real_assetid] : '';
        }//end foreach
        
        return $res;
        
    }//end getAttributeValuesByName()


}//end class

?>