CalendarUtil.php

<?php
    /*********************************************************************************
     * Zurmo is a customer relationship management program developed by
     * Zurmo, Inc. Copyright (C) 2017 Zurmo Inc.
     *
     * Zurmo is free software; you can redistribute it and/or modify it under
     * the terms of the GNU Affero General Public License version 3 as published by the
     * Free Software Foundation with the addition of the following permission added
     * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
     * IN WHICH THE COPYRIGHT IS OWNED BY ZURMO, ZURMO DISCLAIMS THE WARRANTY
     * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
     *
     * Zurmo is distributed in the hope that it will be useful, but WITHOUT
     * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
     * FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public License for more
     * details.
     *
     * You should have received a copy of the GNU Affero General Public License along with
     * this program; if not, see http://www.gnu.org/licenses or write to the Free
     * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
     * 02110-1301 USA.
     *
     * You can contact Zurmo, Inc. with a mailing address at 27 North Wacker Drive
     * Suite 370 Chicago, IL 60606. or at email address contact@zurmo.com.
     *
     * The interactive user interfaces in original and modified versions
     * of this program must display Appropriate Legal Notices, as required under
     * Section 5 of the GNU Affero General Public License version 3.
     *
     * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
     * these Appropriate Legal Notices must retain the display of the Zurmo
     * logo and Zurmo copyright notice. If the display of the logo is not reasonably
     * feasible for technical reasons, the Appropriate Legal Notices must display the words
     * "Copyright Zurmo Inc. 2017. All rights reserved".
     ********************************************************************************/

    class CalendarUtil
    {
        public static function makeCalendarItemByModel(RedBeanModel $model, SavedCalendar $savedCalendar)
        {
            $calendarItem   = new CalendarItem();
            $startAttribute = $savedCalendar->startAttributeName;
            $endAttribute   = $savedCalendar->endAttributeName;
            Yii::app()->custom->setCalendarItemTitle($calendarItem, $model);
            $calendarItem->setStartDateTime($model->$startAttribute);
            if ($endAttribute != null)
            {
                $calendarItem->setEndDateTime($model->$endAttribute);
            }
            $calendarItem->setCalendarId($savedCalendar->id);
            $calendarItem->setModelClass(get_class($model));
            $calendarItem->setModelId($model->id);
            $calendarItem->setColor($savedCalendar->color);
            $calendarItem->setModuleClassName($savedCalendar->moduleClassName);
            return $calendarItem;
        }

        public static function getDateRangeType()
        {
            return SavedCalendar::DATERANGE_TYPE_MONTH;
        }

        public static function getStartDate($dateRangeType)
        {
            assert('is_string($dateRangeType)');
            if($dateRangeType == SavedCalendar::DATERANGE_TYPE_MONTH)
            {
                return DateTimeUtil::getFirstDayOfAMonthDate();
            }
            if($dateRangeType == SavedCalendar::DATERANGE_TYPE_WEEK)
            {
                return DateTimeUtil::getFirstDayOfAWeek();
            }
            if($dateRangeType == SavedCalendar::DATERANGE_TYPE_DAY)
            {
                return DateTimeUtil::getTodaysDate();
            }
        }

        public static function getEndDate($dateRangeType)
        {
            assert('is_string($dateRangeType)');
            if($dateRangeType == SavedCalendar::DATERANGE_TYPE_MONTH)
            {
                $dateTime = new DateTime();
                $dateTime->modify('first day of next month');
                return Yii::app()->dateFormatter->format(DatabaseCompatibilityUtil::getDateFormat(),
                        $dateTime->getTimestamp());
            }
            if($dateRangeType == SavedCalendar::DATERANGE_TYPE_WEEK)
            {
                $dateTime       = new DateTime('Monday next week');
                return Yii::app()->dateFormatter->format(DatabaseCompatibilityUtil::getDateFormat(),
                        $dateTime->getTimestamp());
            }
            if($dateRangeType == SavedCalendar::DATERANGE_TYPE_DAY)
            {
                return DateTimeUtil::getTomorrowsDate();
            }
        }

        public static function getUserSavedCalendars(User $user)
        {
            $metadata = array();
            $metadata['clauses'] = array(
                1 => array(
                    'attributeName'        => 'owner',
                    'relatedAttributeName' => 'id',
                    'operatorType'         => 'equals',
                    'value'                => $user->id,
                )
            );
            $metadata['structure'] = '1';
            $joinTablesAdapter   = new RedBeanModelJoinTablesQueryAdapter('SavedCalendar');
            $where  = RedBeanModelDataProvider::makeWhere('SavedCalendar', $metadata, $joinTablesAdapter);
            return SavedCalendar::getSubset($joinTablesAdapter, null, null, $where);
        }

        public static function processUserCalendarsAndMakeDataProviderForCombinedView($myCalendarIds = null,
                                                                                      $mySubscribedCalendarIds = null,
                                                                                      $dateRangeType = null,
                                                                                      $startDate = null,
                                                                                      $endDate = null)
        {
            $savedCalendarSubscriptions = SavedCalendarSubscriptions::makeByUser(Yii::app()->user->userModel,
                                                                                 $myCalendarIds,
                                                                                 $mySubscribedCalendarIds);
            if($dateRangeType == null)
            {
                $dateRangeType  = CalendarUtil::getDateRangeType();
                ZurmoConfigurationUtil::setByUserAndModuleName(Yii::app()->user->userModel,
                                                               'CalendarsModule',
                                                               'myCalendarDateRangeType', $dateRangeType);
            }
            if($startDate == null)
            {
                $startDate      = CalendarUtil::getStartDate($dateRangeType);
                ZurmoConfigurationUtil::setByUserAndModuleName(Yii::app()->user->userModel,
                                                               'CalendarsModule',
                                                               'myCalendarStartDate', $startDate);
            }
            if($endDate == null)
            {
                $endDate        = CalendarUtil::getEndDate($dateRangeType);
                ZurmoConfigurationUtil::setByUserAndModuleName(Yii::app()->user->userModel,
                                                               'CalendarsModule',
                                                               'myCalendarEndDate', $endDate);
            }
            return CalendarItemsDataProviderFactory::getDataProviderByDateRangeType($savedCalendarSubscriptions,
                                                                                                $startDate, $endDate, $dateRangeType);
        }

        public static function getFullCalendarItems(CalendarItemsDataProvider $dataProvider)
        {
            $fullCalendarItems     = self::processDataProviderAndGetCalendarItems($dataProvider);
            return self::processCalendarItemsAndAddMoreEventsIfRequired($fullCalendarItems);
        }

        public static function processCalendarItemsAndAddMoreEventsIfRequired($fullCalendarItems)
        {
            $modifiedCalendarItems          = array();
            $dateToCalendarItemsCountData   = array();
            $moreEventsItemCreatedByDate    = array();
            foreach ($fullCalendarItems as $key => $fullCalItem)
            {
                $startDate       = date('Y-m-d', strtotime($fullCalItem['start']));
                //Check for the count of cal items on a given start date and if more than max add more events
                if (isset($dateToCalendarItemsCountData[$startDate])
                            && (count($dateToCalendarItemsCountData[$startDate]) >= CalendarItemsDataProvider::MAXIMUM_CALENDAR_ITEMS_DISPLAYED_FOR_ANY_DATE))
                {
                    if (in_array($startDate, $moreEventsItemCreatedByDate) === false)
                    {
                        $fullCalItem           = self::createMoreEventsCalendarItem($fullCalItem, $key, $fullCalendarItems);
                        $moreEventsItemCreatedByDate[] = $startDate;
                    }
                    else
                    {
                        continue;
                    }
                }
                $fullCalItem['start'] = self::getFullCalendarFormattedDateTimeElement($fullCalItem['start']);
                if (isset($fullCalItem['end']))
                {
                    $fullCalItem['end'] = self::getFullCalendarFormattedDateTimeElement($fullCalItem['end']);
                }
                $dateToCalendarItemsCountData[$startDate][] = $fullCalItem;
                $modifiedCalendarItems[] = $fullCalItem;
            }
            return $modifiedCalendarItems;
        }

        public static function createMoreEventsCalendarItem($fullCalItem, $key, $fullCalendarItems)
        {
            $moreEventsCalItem = array();
            $moreEventsCalItem['title'] = Zurmo::t('CalendarsModule', 'More Events..');
            $moreEventsCalItem['start'] = $fullCalItem['start'];
            $moreEventsCalItem['end']   = $fullCalItem['end'];
            $moreEventsCalItem['color'] = '#cccccc';
            $moreEventsCalItem['className'] = 'more-events';
            return $moreEventsCalItem;
        }

        public static function compareCalendarItemsByDateTime($firstDate, $secondDate)
        {
            assert('is_array($firstDate)');
            assert('is_array($secondDate)');
            $firstDateUnixTimestamp = strtotime($firstDate['start']);
            $secondDateUnixTimestamp = strtotime($secondDate['start']);
            return $firstDateUnixTimestamp - $secondDateUnixTimestamp;
        }

        public static function getFullCalendarFormattedDateTimeElement($dateTime)
        {
            assert('is_string($dateTime)');
            //The reason its put because timezone can vary from -12:00 to +12:00 max so
            //if we offset the gmt date by timezoneoffset, on applying offset, correct results
            //would come.
            if (DateTimeUtil::isValidDbFormattedDate($dateTime))
            {
                $dateTime = DateTimeUtil::convertDateToDateTimeByTimeZoneOffset($dateTime);
            }
            $dateTimeObject  = new DateTime();
            $dateTimeObject->setTimestamp(strtotime($dateTime));
            $offset          = ZurmoTimeZoneHelper::getTimeZoneOffset();
            if ($offset < 0)
            {
                $offset = abs($offset);
                $dateTimeObject->sub(new DateInterval('PT' . $offset . 'S'));
            }
            else
            {
                $dateTimeObject->add(new DateInterval('PT' . $offset . 'S'));
            }
            return $dateTimeObject->format('c');
        }

        public static function getUsedCalendarColorsByUser(User $user, $modelClassName, $attributeName)
        {
            assert('is_string($modelClassName)');
            assert('is_string($attributeName)');
            $selectDistinct            = false;
            $joinTablesAdapter         = new RedBeanModelJoinTablesQueryAdapter($modelClassName);
            $selectQueryAdapter        = new RedBeanModelSelectQueryAdapter($selectDistinct);
            $selectQueryAdapter->addClause($modelClassName::getTableName(), 'color');
            $metadata                  = array();
            $metadata['clauses']       = array(
                                                    1 => array(
                                                        'attributeName'        => $attributeName,
                                                        'relatedAttributeName' => 'id',
                                                        'operatorType'         => 'equals',
                                                        'value'                => $user->id,
                                                    )
                                                );
            $metadata['structure'] = '1';
            $where   = RedBeanModelDataProvider::makeWhere($modelClassName, $metadata, $joinTablesAdapter);
            $sql     = SQLQueryUtil::makeQuery($modelClassName::getTableName(), $selectQueryAdapter, $joinTablesAdapter, null, null, $where);
            $records = ZurmoRedBean::getAll($sql);
            $colors  = array();
            foreach ($records as $record)
            {
                if ($record['color'] != null && $record['color'] != '')
                {
                    $colors[] = $record['color'];
                }
            }
            return $colors;
        }

        public static function getModalContainerId()
        {
            return ModalContainerView::ID;
        }

        public static function resolveAjaxOptionsForModalView()
        {
            $title = Zurmo::t('Calendarsmodule', 'Shared Calendars');
            return   ModalView::getAjaxOptionsForModalLink($title, self::getModalContainerId(), 'auto', 600,
                     array('my'=>'center top+25','at'=>'center top+25'), $class = "''");
        }

        public static function registerSharedCalendarModalScript($url, $selector)
        {
            assert('is_string($url)');
            assert('is_string($selector)');
            $modalId     = CalendarUtil::getModalContainerId();
            $ajaxOptions = CalendarUtil::resolveAjaxOptionsForModalView();
            $ajaxOptions['beforeSend'] = new CJavaScriptExpression($ajaxOptions['beforeSend']);
            return "$(document).on('click', '{$selector}', function()
                         {
                            $.ajax(
                            {
                                'type' : 'GET',
                                'url'  : '{$url}',
                                'beforeSend' : {$ajaxOptions['beforeSend']},
                                'update'     : '{$ajaxOptions['update']}',
                                'success': function(html){jQuery('#{$modalId}').html(html)}
                            });
                          }
                        );";
        }

        public static function getUserSubscribedCalendars(User $user)
        {
            $searchAttributeData = array();
            $searchAttributeData['clauses'] = array(
                1 => array(
                    'attributeName'             => 'user',
                    'relatedAttributeName'      => 'id',
                    'operatorType'              => 'equals',
                    'value'                     => intval($user->id),
                )
            );
            $searchAttributeData['structure'] = '1';
            $joinTablesAdapter                = new RedBeanModelJoinTablesQueryAdapter('SavedCalendarSubscription');
            $where  = RedBeanModelDataProvider::makeWhere('SavedCalendarSubscription', $searchAttributeData, $joinTablesAdapter);
            $models = SavedCalendarSubscription::getSubset($joinTablesAdapter, null, null, $where, null);
            return $models;
        }

        public static function makeCalendarItemsList($data, $field, $itemClass, $type)
        {
            assert('is_array($data)');
            assert('is_string($field)');
            assert('is_string($itemClass)');
            assert('is_string($type)');
            $itemsContent = null;
            foreach ($data as $calendarArray)
            {
                $isChecked = false;
                if ($calendarArray[1] === true)
                {
                    $isChecked = true;
                }
                $input          = ZurmoHtml::checkBox($field,
                                                      $isChecked,
                                                      array('value' => $calendarArray[0]->id,
                                                            'class' => $itemClass));
                $color          = ZurmoHtml::tag('span', array('class' => 'cal-color', 'style' => 'background:' .
                                                                                                        $calendarArray[0]->color), '');
                if ($type == 'saved')
                {
                    $label          = $calendarArray[0]->name;
                    $options        = self::getSavedCalendarOptions($calendarArray[0]->id);
                    $subscriptionData = null;
                }
                else
                {
                    $savedCalendar    = $calendarArray[0]->savedcalendar;
                    $label            = $savedCalendar->name;
                    $options          = self::getSharedCalendarOptions($calendarArray[0]->id);
                    $subscriptionData = CalendarUtil::getCalendarSubscriberData($calendarArray[0]->savedcalendar);
                }
                $label = ZurmoHtml::tag('strong', array('class' => 'cal-name'), $label);
                $itemsContent   .= ZurmoHtml::tag('li', array(), $input . $color . $label . $subscriptionData . $options);
            }
            return ZurmoHtml::tag('ul', array('class' => 'calendars-list'), $itemsContent);
        }

        public static function getSharedCalendarOptions($savedCalendarSubscriptionId)
        {
            assert('is_int($savedCalendarSubscriptionId)');
            $elementContent = ZurmoHtml::tag('li', array(),
                                            ZurmoHtml::link(ZurmoHtml::tag('span', array(), Zurmo::t('Core', 'Unsubscribe')), '#',
                                                    array('data-value'  => $savedCalendarSubscriptionId,
                                                          'class'       => 'shared-cal-unsubscribe')));
            $elementContent = ZurmoHtml::tag('ul', array(), $elementContent);
            $content        = ZurmoHtml::tag('li', array('class' => 'parent last'),
                                                   ZurmoHtml::link('<span></span>', 'javascript:void(0);') . $elementContent);
            $content        = ZurmoHtml::tag('ul', array('class' => 'options-menu edit-row-menu nav'), $content);
            return $content;
        }

        public static function getSavedCalendarOptions($calendarId)
        {
            assert('is_int($calendarId)');
            $editUrl         = Yii::app()->createUrl('calendars/default/edit', array('id' => $calendarId));
            $editLinkContent = ZurmoHtml::tag('li', array(),
                                            ZurmoHtml::link(ZurmoHtml::tag('span', array(), Zurmo::t('Core', 'Edit')), $editUrl,
                                                    array('data-value'  => $calendarId,
                                                          'class'       => 'my-cal-edit')));
            $deleteLinkContent = ZurmoHtml::tag('li', array(),
                                            ZurmoHtml::link(ZurmoHtml::tag('span', array(), Zurmo::t('Core', 'Delete')), '#',
                                                    array('data-value'  => $calendarId,
                                                          'class'       => 'my-cal-delete')));
            $elementContent = ZurmoHtml::tag('ul', array(), $editLinkContent . $deleteLinkContent);
            $content        = ZurmoHtml::tag('li', array('class' => 'parent last'),
                                                   ZurmoHtml::link('<span></span>', 'javascript:void(0);') . $elementContent);
            $content        = ZurmoHtml::tag('ul', array('class' => 'options-menu edit-row-menu nav'), $content);
            return $content;
        }

        public static function getCalendarItemsDataProvider(User $user)
        {
            $mySavedCalendarIds         = ZurmoConfigurationUtil::getByUserAndModuleName($user,
                                                                                        'CalendarsModule', 'myCalendarSelections');
            $mySubscribedCalendarIds    = ZurmoConfigurationUtil::getByUserAndModuleName($user,
                                                                                        'CalendarsModule', 'mySubscribedCalendarSelections');
            $dateRangeType              = ZurmoConfigurationUtil::getByUserAndModuleName($user,
                                                                                        'CalendarsModule', 'myCalendarDateRangeType');
            $startDate                  = ZurmoConfigurationUtil::getByUserAndModuleName($user,
                                                                                        'CalendarsModule', 'myCalendarStartDate');
            $endDate                    = ZurmoConfigurationUtil::getByUserAndModuleName($user,
                                                                                        'CalendarsModule', 'myCalendarEndDate');
            return CalendarUtil::processUserCalendarsAndMakeDataProviderForCombinedView($mySavedCalendarIds,
                                                                                        $mySubscribedCalendarIds,
                                                                                        $dateRangeType,
                                                                                        $startDate,
                                                                                        $endDate);
        }

        public static function getUsersSubscribedForCalendar(SavedCalendar $subscribedCalendar)
        {
            $searchAttributeData = array();
            $users               = array();
            $searchAttributeData['clauses'] = array(
                1 => array(
                    'attributeName'             => 'savedcalendar',
                    'relatedAttributeName'      => 'id',
                    'operatorType'              => 'equals',
                    'value'                     => intval($subscribedCalendar->id),
                )
            );
            $searchAttributeData['structure'] = '1';
            $joinTablesAdapter                = new RedBeanModelJoinTablesQueryAdapter('SavedCalendarSubscription');
            $where  = RedBeanModelDataProvider::makeWhere('SavedCalendarSubscription', $searchAttributeData, $joinTablesAdapter);
            $models = SavedCalendarSubscription::getSubset($joinTablesAdapter, null, null, $where, null);
            foreach ($models as $model)
            {
                $users[] = $model->user;
            }
            return $users;
        }

        public static function getCalendarSubscriberData(SavedCalendar $subscribedCalendar)
        {
            $users    = CalendarUtil::getUsersSubscribedForCalendar($subscribedCalendar);
            $content  = null;
            $alreadySubscribedUsers = array();
            foreach ($users as $user)
            {
                //Take care of duplicates if any
                if (!in_array($user->id, $alreadySubscribedUsers))
                {
                    $content .= NotificationSubscriberUtil::renderSubscriberImageAndLinkContent($user, 25);
                    $alreadySubscribedUsers[] = $user->id;
                }
            }

            return $content;
        }

        public static function registerSelectCalendarScript($startDate, $endDate)
        {
            //refer to http://stackoverflow.com/questions/9801095/jquery-fullcalendar-send-custom-parameter-and-refresh-calendar-with-json
            $script = "$(document).on('click', '.mycalendar,.sharedcalendar',
                                        function(){
                                                    $('#calendar').fullCalendar('refetchEvents');
                                                  }
                                     );";
            $cs = Yii::app()->getClientScript();
            $cs->registerScript('mycalendarselectscript', $script);
        }

        public static function getAlreadyUsedColorsByUser(User $user)
        {
            $savedCalUsedColors      = CalendarUtil::getUsedCalendarColorsByUser($user, 'SavedCalendar', 'createdByUser');
            $sharedCalUsedColors     = CalendarUtil::getUsedCalendarColorsByUser($user, 'SavedCalendarSubscription', 'user');
            return CMap::mergeArray($savedCalUsedColors, $sharedCalUsedColors);
        }

        public static function setMyCalendarColor(SavedCalendar $savedCalendar, User $user)
        {
            if($savedCalendar->color == null)
            {
                $usedColors      = CalendarUtil::getAlreadyUsedColorsByUser($user);
                self::processAndSaveColor($savedCalendar, $usedColors);
            }
        }

        public static function setSharedCalendarColor(SavedCalendarSubscription $sharedCalendar)
        {
            if($sharedCalendar->color == null)
            {
                $usedColors      = CalendarUtil::getAlreadyUsedColorsByUser(Yii::app()->user->userModel);
                self::processAndSaveColor($sharedCalendar, $usedColors);
            }
        }

        public static function processAndSaveColor($calendar, $usedColors)
        {
            assert('$calendar instanceof SavedCalendar || $calendar instanceof SavedCalendarSubscription');
            assert('is_array($usedColors)');
            $availableColors = SavedCalendar::$colorsArray;
            $filteredColors  = array_diff($availableColors, $usedColors);
            $color           = array_shift($filteredColors);
            $calendar->color = $color;
            $calendar->save();
        }

        public static function registerSavedCalendarDeleteScript($startDate, $endDate)
        {
            assert('is_string($startDate)');
            assert('is_string($endDate)');
            $url = Yii::app()->createUrl('calendars/default/delete');
            $eventsUrl  = Yii::app()->createUrl('calendars/default/getEvents');
            $params = LabelUtil::getTranslationParamsForAllModules();
            $confirmTitle  = Zurmo::t('Core', 'Are you sure you want to delete this {modelLabel}?',
            array('{modelLabel}' => Zurmo::t('CalendarsModule', 'CalendarsModuleSingularLabel', $params)));
            // Begin Not Coding Standard

            $script = "$(document).on('click', '.my-cal-delete', function()
                         {
                            if (!confirm('{$confirmTitle}'))
                            {
                                return false;
                            }
                            var calId = $(this).data('value');
                            $.ajax(
                            {
                                'type' : 'GET',
                                'url'  : '{$url}' + '?id=' + calId,
                                beforeSend: function(xhr)
                                            {
                                                $('#my-calendars-list').html('');
                                                $(this).makeLargeLoadingSpinner(true, '#my-calendars-list');
                                            },
                                success : function(data)
                                          {
                                                $('#my-calendars-list').html(data);
                                                $(this).makeLargeLoadingSpinner(false, '#my-calendars-list');
                                                $('#calendar').fullCalendar('removeEventSource', getCalendarEvents('{$eventsUrl}', 'calendar'));
                                                $('#calendar').fullCalendar('addEventSource', getCalendarEvents('{$eventsUrl}', 'calendar'));
                                          }
                            });

                          }
                        );";

             // End Not Coding Standard
             $cs         = Yii::app()->getClientScript();
             if($cs->isScriptRegistered('calDeleteScript', ClientScript::POS_END) === false)
             {
                $cs->registerScript('calDeleteScript', $script, ClientScript::POS_END);
             }
        }

        public static function registerCalendarUnsubscriptionScript($startDate, $endDate)
        {
            assert('is_string($startDate)');
            assert('is_string($endDate)');
            $url        = Yii::app()->createUrl('/calendars/default/unsubscribe');
            $eventsUrl  = Yii::app()->createUrl('calendars/default/getEvents');
            // Begin Not Coding Standard

            $script     = "$(document).on('click', '.shared-cal-unsubscribe', function(){
                            $.ajax(
                            {
                                type : 'GET',
                                url  : '{$url}',
                                data : {'id' : $(this).data('value')},
                                beforeSend: function(xhr)
                                            {
                                                $('#shared-calendars-list').html('');
                                                $(this).makeLargeLoadingSpinner(true, '#shared-calendars-list');
                                            },
                                success : function(data)
                                          {
                                                $('#shared-calendars-list').html(data);
                                                $(this).makeLargeLoadingSpinner(false, '#shared-calendars-list');
                                                $('#calendar').fullCalendar('removeEventSource', getCalendarEvents('{$eventsUrl}', 'calendar'));
                                                $('#calendar').fullCalendar('addEventSource', getCalendarEvents('{$eventsUrl}', 'calendar'));
                                          }
                            }
                            );
                      })";

            // End Not Coding Standard
            $cs         = Yii::app()->getClientScript();
            $cs->registerScript('calunsubscribescript', $script, ClientScript::POS_END);
        }

        public static function getModelAttributesForSelectedModule($moduleClassName)
        {
            $modelClassName         = $moduleClassName::getPrimaryModelName();
            $adapter                = new ModelAttributesAdapter(new $modelClassName(false));
            $attributes             = $adapter->getAttributes();
            $selectedAttributes     = array();
            foreach ($attributes as $attribute => $value)
            {
                if ($value['elementType'] == 'DateTime' || $value['elementType'] == 'Date')
                {
                    $selectedAttributes[$attribute] = $value['attributeLabel'];
                }
            }
            return $selectedAttributes;
        }

        public static function makeComponentFormAndPopulateReportFromData($componentFormsData, Report $report, $componentPrefix)
        {
            assert('is_string($componentPrefix)');
            assert('is_array($componentFormsData)');
            $moduleClassName    = $report->getModuleClassName();
            $addMethodName      = 'add' . $componentPrefix;
            $componentClassName = $componentPrefix . 'ForReportForm';
            $rowKey             = 0;
            foreach ($componentFormsData as $componentFormData)
            {
                $component      = new $componentClassName($moduleClassName,
                                                          $moduleClassName::getPrimaryModelName(),
                                                          $report->getType(),
                                                          $rowKey);
                $component->setAttributes($componentFormData);
                $report->{$addMethodName}($component);
                $rowKey++;
            }
        }

        public static function saveCalendarWithSerializedData(Report $report, SavedCalendar $savedCalendar, $wizardFormPostData)
        {
            $filtersData          = ArrayUtil::getArrayValue($wizardFormPostData, ComponentForReportForm::TYPE_FILTERS);
            if ($filtersData != null)
            {
                $sanitizedFiltersData = DataToReportUtil::sanitizeFiltersData($report->getModuleClassName(),
                                                                              $report->getType(),
                                                                              $filtersData);
                $unserializedData   = array(ComponentForReportForm::TYPE_FILTERS => $sanitizedFiltersData,
                                        'filtersStructure' => $report->getFiltersStructure());
                $savedCalendar->serializedData = serialize($unserializedData);
            }
            if (!$savedCalendar->save())
            {
                throw new FailedToSaveModelException();
            }
        }

        public static function resolveReportBySavedCalendarPostData($type, $id = null, $postData)
        {
            assert('is_string($type)');
            assert('is_array($postData)');
            if ($id == null)
            {
                $report = new Report();
                $report->setType($type);
            }
            else
            {
                $savedCalendar              = SavedCalendar::getById(intval($id));
                ControllerSecurityUtil::resolveAccessCanCurrentUserWriteModel($savedCalendar);
                $report                     = SavedCalendarToReportAdapter::makeReportBySavedCalendar($savedCalendar);
            }
            if (isset($postData['SavedCalendar']) && isset($postData['SavedCalendar']['moduleClassName']))
            {
                $report->setModuleClassName($postData['SavedCalendar']['moduleClassName']);
            }
            else
            {
                throw new NotSupportedException();
            }
            DataToReportUtil::resolveReportByWizardPostData($report, $postData,
                                                                ReportToWizardFormAdapter::getFormClassNameByType($type));
            return $report;
        }

        public static function getAvailableModulesForCalendar()
        {
            $moduleClassNames = array();
            foreach (self::getCalendarModulesClassNamesCurrentUserHasAccessTo() as $moduleClassName)
            {
                $label                              = $moduleClassName::getModuleLabelByTypeAndLanguage('Plural');
                $moduleClassNames[$moduleClassName] = $label;
            }
            return $moduleClassNames;
        }

        public static function getCalendarModulesClassNamesCurrentUserHasAccessTo()
        {
            $moduleClassNames = array();
            $modules = Module::getModuleObjects();
            foreach ($modules as $module)
            {
                if ($module::canShowOnCalendar())
                {
                    if (RightsUtil::canUserAccessModule(get_class($module), Yii::app()->user->userModel))
                    {
                        $moduleClassNames[] = get_class($module);
                    }
                }
            }
            return $moduleClassNames;
        }

        public static function processAndGetDataProviderForEventsData($selectedMyCalendarIds = null,
                                                                      $selectedSharedCalendarIds = null,
                                                                      $startDate = null,
                                                                      $endDate = null,
                                                                      $dateRangeType = null,
                                                                      $isSticky = true)
        {
            if ($isSticky)
            {
                ZurmoConfigurationUtil::setByUserAndModuleName(Yii::app()->user->userModel,
                                                                   'CalendarsModule',
                                                                   'myCalendarStartDate', $startDate);
                ZurmoConfigurationUtil::setByUserAndModuleName(Yii::app()->user->userModel,
                                                                   'CalendarsModule',
                                                                   'myCalendarEndDate', $endDate);
                ZurmoConfigurationUtil::setByUserAndModuleName(Yii::app()->user->userModel,
                                                                   'CalendarsModule',
                                                                   'myCalendarDateRangeType', $dateRangeType);
            }
            return CalendarUtil::processUserCalendarsAndMakeDataProviderForCombinedView($selectedMyCalendarIds,
                                                                                        $selectedSharedCalendarIds,
                                                                                        $dateRangeType,
                                                                                        $startDate,
                                                                                        $endDate);
        }

        public static function loadDefaultCalendars(User $user)
        {
            $name           = Zurmo::t('CalendarsModule', 'My Meetings');
            $mtgCalendar    = self::populateSavedCalendar($user, $name, 'MeetingsModule', 'startDateTime', 'endDateTime');
            $name           = Zurmo::t('CalendarsModule', 'My Tasks');
            $taskCalendar   = self::populateSavedCalendar($user, $name, 'TasksModule', 'createdDateTime');
            return array($mtgCalendar, $taskCalendar);
        }

        public static function populateSavedCalendar(User $user,
                                                     $name,
                                                     $moduleClassName,
                                                     $startAttributeName,
                                                     $endAttributeName = '')
        {
            $savedCalendar                      = new SavedCalendar();
            $savedCalendar->name                = $name;
            $savedCalendar->timeZone            = $user->timeZone;
            $savedCalendar->location            = 'Chicago';
            $savedCalendar->moduleClassName     = $moduleClassName;
            $savedCalendar->startAttributeName  = $startAttributeName;
            $savedCalendar->endAttributeName    = $endAttributeName;
            assert($savedCalendar->save()); // Not Coding Standard
            CalendarUtil::setMyCalendarColor($savedCalendar, $user);
            $filtersData                        = array('filtersStructure' => '1',
                                                        'Filters' => array(
                                                                            array('attributeIndexOrDerivedType' => 'owner__User',
                                                                            'structurePosition'  => '1',
                                                                            'operator'           => 'equals',
                                                                            'value'              => $user->id,
                                                                            'stringifiedModelForValue'  => strval($user),
                                                                            'availableAtRunTime' => '0')
                                                                          )
                                                       );
            CalendarUtil::populateFiltersDataInModel($savedCalendar, $filtersData);
            assert($savedCalendar->save()); // Not Coding Standard
            return $savedCalendar;
        }

        public static function populateFiltersDataInModel(SavedCalendar $model, $data)
        {
            $report        = SavedCalendarToReportAdapter::makeReportBySavedCalendar($model);
            DataToReportUtil::resolveFiltersStructure($data, $report);
            DataToReportUtil::resolveFilters($data, $report);
            if (count($filtersData = ArrayUtil::getArrayValue($data, ComponentForReportForm::TYPE_FILTERS)) > 0)
            {
                $sanitizedFiltersData  = DataToReportUtil::sanitizeFiltersData($report->getModuleClassName(),
                                                                              $report->getType(),
                                                                              $filtersData);
                $unserializedData      = array(ComponentForReportForm::TYPE_FILTERS => $sanitizedFiltersData,
                                        'filtersStructure' => $report->getFiltersStructure());
                $model->serializedData = serialize($unserializedData);
            }
            else
            {
                $model->serializedData = null;
            }
        }

        public static function processDataProviderAndGetCalendarItems(CalendarItemsDataProvider $dataProvider)
        {
            $calendarItems = $dataProvider->getData(true);
            $fullCalendarItems = array();
            for ($k = 0; $k < count($calendarItems); $k++)
            {
                $fullCalendarItem = array();
                $calItem = $calendarItems[$k];
                $fullCalendarItem['title'] = $calItem->getTitle();
                $fullCalendarItem['start'] = $calItem->getStartDateTime();
                if (!DateTimeUtil::isDateTimeStringNull($calItem->getEndDateTime()))
                {
                    $fullCalendarItem['end'] = $calItem->getEndDateTime();
                }
                else
                {
                    $fullCalendarItem['end'] = '';
                }
                $fullCalendarItem['color']      = $calItem->getColor();
                $fullCalendarItem['modelClass'] = $calItem->getModelClass();
                $fullCalendarItem['modelId']    = $calItem->getModelId();
                $fullCalendarItem['calendarId'] = $calItem->getCalendarId();
                $fullCalendarItem['allDay']     = true;
                $fullCalendarItems[] = $fullCalendarItem;
            }
            if (count($fullCalendarItems) >  0)
            {
                ArrayUtil::sortArrayByElementField('compareCalendarItemsByDateTime', 'usort', $fullCalendarItems, 'CalendarUtil');
            }
            return $fullCalendarItems;
        }

        public static function populateDetailsUrlForCalendarItems($items)
        {
            assert('is_array($items)');
            $moduleClassNames           = CalendarUtil::getAvailableModulesForCalendar();
            foreach ($items as $index => $item)
            {
                foreach ($moduleClassNames as $moduleClassName => $label)
                {
                    if ($moduleClassName::getPrimaryModelName() == $item['modelClass'])
                    {
                        $moduleId           = $moduleClassName::getDirectoryName();
                        $item['detailsUrl'] = Yii::app()->createUrl($moduleId . '/default/details', array('id' => $item['modelId']));
                        $items[$index]      = $item;
                    }
                }
            }
            return $items;
        }
    }
?>