DataUtil.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 DataUtil
    {
        protected static $skippedAttributes = array();

        public static function sanitizeDataByDesignerTypeForSavingModel($model, $data)
        {
            assert('$model instanceof RedBeanModel || $model instanceof ModelForm');
            assert('is_array($data)');
            foreach ($data as $attributeName => $value)
            {
                if ($value !== null && static::isNotMarkedSkipped($attributeName))
                {
                    if (!is_array($value))
                    {
                        if ($model->isAttribute($attributeName) && $model->isAttributeSafe($attributeName))
                        {
                            $designerType = ModelAttributeToDesignerTypeUtil::getDesignerType(
                                                $model, $attributeName);
                            if ($designerType == 'Date' && !empty($value))
                            {
                                $data[$attributeName] = DateTimeUtil::resolveValueForDateDBFormatted($value);
                            }
                            if ($designerType == 'DateTime' && !empty($value))
                            {
                                $data[$attributeName] = DateTimeUtil::convertDateTimeLocaleFormattedDisplayToDbFormattedDateTimeWithSecondsAsZero($value);
                            }
                            $data[$attributeName] = static::purifyHtml($data[$attributeName]);
                        }
                    }
                    else
                    {
                        try
                        {
                            $designerType = ModelAttributeToDesignerTypeUtil::getDesignerType($model, $attributeName);
                        }
                        catch (NotImplementedException $e)
                        {
                            //In the event that a designer type does not exist.
                            $designerType = null;
                        }
                        if ($model->isAttributeSafe($attributeName) && $designerType != 'TagCloud')
                        {
                            if ($designerType == 'MixedDateTypesForSearch' && isset($value['firstDate']) &&
                                $value['firstDate'] != null)
                            {
                                $data[$attributeName]['firstDate'] = DateTimeUtil::
                                                                         resolveValueForDateDBFormatted(
                                                                         $value['firstDate']);
                            }
                            if ($designerType == 'MixedDateTypesForSearch' && isset($value['secondDate']) &&
                            $value['secondDate'] != null)
                            {
                                $data[$attributeName]['secondDate'] = DateTimeUtil::
                                                                     resolveValueForDateDBFormatted(
                                                                     $value['secondDate']);
                            }
                        }
                        elseif (isset($value['values']) && is_string($value['values']) && $designerType == 'TagCloud')
                        {
                            if ($data[$attributeName]['values'] == '')
                            {
                                $data[$attributeName]['values'] = array();
                            }
                            else
                            {
                                $data[$attributeName]['values'] = explode(',', $data[$attributeName]['values']); // Not Coding Standard
                            }
                        }
                        if ($designerType == 'CheckBox')
                        {
                            $data[$attributeName] = $value['value'];
                        }
                        else
                        {
                            array_walk_recursive($data[$attributeName], array(get_called_class(), 'purifyHtmlAndModifyInput'));
                        }
                    }
                }
            }
            return $data;
        }

        public static function sanitizeDataToJustHavingElementForSavingModel($sanitizedData, $elementName)
        {
            assert('is_array($sanitizedData)');
            assert('is_string($elementName) || is_int($elementName)');
            if (!isset($sanitizedData[$elementName]))
            {
                return null;
            }
            return array($elementName => $sanitizedData[$elementName]);
        }

        public static function removeElementFromDataForSavingModel($sanitizedData, $elementName)
        {
            assert('is_array($sanitizedData)');
            assert('is_string($elementName) || is_int($elementName)');
            if (isset($sanitizedData[$elementName]))
            {
                unset($sanitizedData[$elementName]);
            }
            return $sanitizedData;
        }

        public static function purifyHtml($text)
        {
            if (is_string($text))
            {
                $safeCharacters     = array('&' => '&amp;',
                                            '[' => '%5B',
                                            '^' => '%5E',
                                            ']' => '%5D',
                                            '%' => '%25',
                                            '<' => '&lt;',
                                            '>' => '&gt;');
                $purifier           = new CHtmlPurifier();
                $purifier->options  = array('Cache.SerializerPermissions' => 0777,
                                            'Attr.AllowedFrameTargets' => '_blank');
                $purifiedText       = $purifier->purify($text);
                foreach ($safeCharacters as $specialCharacter => $purifiedCode)
                {
                    if (strpos($text, $specialCharacter) !== false)
                    {
                        $purifiedText = str_replace($purifiedCode, $specialCharacter, $purifiedText);
                    }
                }
                $text = $purifiedText;
            }
            return $text;
        }

        public static function purifyHtmlAndModifyInput(&$item)
        {
            assert('is_scalar($item) || empty($item)');
            if (!empty($item))
            {
                $item = static::purifyHtml($item);
            }
        }

        protected static function isNotMarkedSkipped($attributeName)
        {
            return !(in_array($attributeName, static::$skippedAttributes));
        }
    }
?>