Quotas.php

<?php

namespace LimeSurvey\Models\Services;

/**
 * @todo Possible remove this warning
 * @SuppressWarnings(PHPMD.ExcessiveClassComplexity)
 */
class Quotas
{
    /** @var \Survey the survey */
    private $survey;


    /**
     * Quicktranslation constructor.
     *
     * @param \Survey $survey the survey object
     *
     */
    public function __construct(\Survey $survey)
    {
        $this->survey = $survey;
    }


    /**
     * In the array are
     * qoutaId[
     *   aQuotaItems = [
     *      oQuestion,
     *      answerTitle,
     *      quotaMember
     *      valid ???
     *   ]
     * ]
     *
     * @return array
     */
    public function getQuotaStructure()
    {
        $totalquotas = 0;
        $totalcompleted = 0;
        if (!empty($this->survey->quotas)) {
            $aQuotaItems = array();
            //loop through all quotas
            foreach ($this->survey->quotas as $oQuota) {
                $totalquotas += $oQuota->qlimit;
                $totalcompleted += $oQuota->completeCount;

                //loop through all quotaMembers
                foreach ($oQuota->quotaMembers as $oQuotaMember) {
                    $aQuestionAnswers = self::getQuotaAnswers($oQuotaMember['qid'], $oQuota['id']);
                    if ($oQuotaMember->question->type == '*') {
                        $answerText = $oQuotaMember->code;
                    } else {
                        $answerText = isset($aQuestionAnswers[$oQuotaMember['code']]) ? flattenText($aQuestionAnswers[$oQuotaMember['code']]['Display']) : null;
                    }

                    $aQuotaItems[$oQuota['id']][] = array(
                        'oQuestion' => \Question::model()
                            ->with('questionl10ns', array('language' => $this->survey->language))
                            ->findByPk(array('qid' => $oQuotaMember['qid'])),
                        'answer_title' => $answerText,
                        'oQuotaMember' => $oQuotaMember,
                        'valid' => isset($answerText),
                    );
                }
            }
            $aData['aQuotaItems'] = $aQuotaItems;

            // take the last quota as base for bulk edits
            $aData['oQuota'] = $oQuota;
            $aData['aQuotaLanguageSettings'] = array();
            foreach ($oQuota->languagesettings as $languagesetting) {
                $aData['aQuotaLanguageSettings'][$languagesetting->quotals_language] = $languagesetting;
            }
        }
        $aData['totalquotas'] = $totalquotas;
        $aData['totalcompleted'] = $totalcompleted;

        return $aData;
    }

    /**
     * Returns an answerlist for a specific question type and marks already used answers as such.
     *
     * @todo Refactor and remove phpmd warning
     * @param integer $iQuestionId
     * @param integer $iQuotaId
     * @return array
     * @SuppressWarnings(PHPMD.ExcessiveMethodLength)
     */
    public function getQuotaAnswers(int $iQuestionId, int $iQuotaId)
    {
        $iQuestionId = sanitize_int($iQuestionId);
        $iQuotaId    = sanitize_int($iQuotaId);
        $sBaseLang = $this->survey->language;

        $aQuestion = \Question::model()
            ->with('questionl10ns', array('language' => $sBaseLang))
            ->findByPk(array('qid' => $iQuestionId));
        $aQuestionType = $aQuestion['type'];
        $aAnswerList = [];
        switch ($aQuestionType) {
            case \Question::QT_M_MULTIPLE_CHOICE:
                $aResults = \Question::model()
                    ->with('questionl10ns', array('language' => $sBaseLang))
                    ->findAllByAttributes(array('parent_qid' => $iQuestionId));
                foreach ($aResults as $oDbAnsList) {
                    $tmparrayans = array('Title' => $aQuestion['title'],
                        'Display' => substr((string) $oDbAnsList->questionl10ns[$sBaseLang]->question, 0, 40),
                        'code' => $oDbAnsList->title);
                    $aAnswerList[$oDbAnsList->title] = $tmparrayans;
                }
                break;
            case \Question::QT_G_GENDER:
                $aAnswerList = array(
                    'M' => array('Title' => $aQuestion['title'], 'Display' => gT("Male"), 'code' => 'M'),
                    'F' => array('Title' => $aQuestion['title'], 'Display' => gT("Female"), 'code' => 'F'));
                break;
            case \Question::QT_L_LIST:
            case \Question::QT_O_LIST_WITH_COMMENT:
            case \Question::QT_EXCLAMATION_LIST_DROPDOWN:
                $aAnsResults = \Answer::model()
                ->with('answerl10ns', array('language' => $sBaseLang))
                ->findAllByAttributes(array('qid' => $iQuestionId));

                foreach ($aAnsResults as $aDbAnsList) {
                    $aAnswerList[$aDbAnsList['code']] = array('Title' => $aQuestion['title'],
                    'Display' => $aDbAnsList->answerl10ns[$sBaseLang]->answer,
                    'code' => $aDbAnsList['code']);
                }
                break;
            case \Question::QT_A_ARRAY_5_POINT:
                $aAnsResults = \Question::model()
                    ->with('questionl10ns', array('language' => $sBaseLang))
                    ->findAllByAttributes(array('parent_qid' => $iQuestionId));

                foreach ($aAnsResults as $aDbAnsList) {
                    for ($x = 1; $x < 6; $x++) {
                        $tmparrayans = array('Title' => $aQuestion['title'],
                            'Display' => substr((string) $aDbAnsList->questionl10ns[$sBaseLang]->question, 0, 40) . ' [' . $x . ']',
                            'code' => $aDbAnsList['title']);
                        $aAnswerList[$aDbAnsList['title'] . "-" . $x] = $tmparrayans;
                    }
                }
                break;
            case \Question::QT_B_ARRAY_10_CHOICE_QUESTIONS:
                $aAnsResults = \Question::model()
                    ->with('questionl10ns', array('language' => $sBaseLang))
                    ->findAllByAttributes(array('parent_qid' => $iQuestionId));

                foreach ($aAnsResults as $aDbAnsList) {
                    for ($x = 1; $x < 11; $x++) {
                        $tmparrayans = array('Title' => $aQuestion['title'],
                            'Display' => substr((string) $aDbAnsList->questionl10ns[$sBaseLang]->question, 0, 40) . ' [' . $x . ']',
                            'code' => $aDbAnsList['title']);
                        $aAnswerList[$aDbAnsList['title'] . "-" . $x] = $tmparrayans;
                    }
                }
                break;
            case \Question::QT_Y_YES_NO_RADIO:
                $aAnswerList = array(
                    'Y' => array('Title' => $aQuestion['title'], 'Display' => gT("Yes"), 'code' => 'Y'),
                    'N' => array('Title' => $aQuestion['title'], 'Display' => gT("No"), 'code' => 'N'));
                break;
            case \Question::QT_I_LANGUAGE:
                $slangs = $this->survey->allLanguages;

                foreach ($slangs as $key => $value) {
                    $tmparrayans = array('Title' => $aQuestion['title'],
                        'Display' => getLanguageNameFromCode($value, false), $value);
                    $aAnswerList[$value] = $tmparrayans;
                }
                break;
        }

        if (!empty($aAnswerList)) {
            // Now we mark answers already used in this quota as such
            $aExistsingAnswers = \QuotaMember::model()->findAllByAttributes(array('sid' => $this->survey->sid,
                'qid' => $iQuestionId, 'quota_id' => $iQuotaId));
            foreach ($aExistsingAnswers as $aAnswerRow) {
                if (array_key_exists($aAnswerRow['code'], $aAnswerList)) {
                    $aAnswerList[$aAnswerRow['code']]['rowexists'] = '1';
                }
            }
        }

        return  $aAnswerList;
    }

    /**
     * Saves the new quota and it's language settings.
     *
     * @param $quotaParams array the quota attributes
     * @return \Quota the new quota with added QuotaLanguageSettings, or Quota with errors
     * @throws \CDbException
     */
    public function saveNewQuota(array $quotaParams): \Quota
    {
        $oQuota = new \Quota();
        $oQuota->sid = $this->survey->sid;
        $oQuota->attributes = $quotaParams;
        if ($oQuota->save()) {
            foreach ($_POST['QuotaLanguageSetting'] as $language => $settingAttributes) {
                $oQuotaLanguageSetting = new \QuotaLanguageSetting();
                $oQuotaLanguageSetting->attributes = $settingAttributes;
                $oQuotaLanguageSetting->quotals_quota_id = $oQuota->primaryKey;
                $oQuotaLanguageSetting->quotals_language = $language;

                //Clean XSS - Automatically provided by CI
                $oQuotaLanguageSetting->quotals_message = html_entity_decode($oQuotaLanguageSetting->quotals_message, ENT_QUOTES, "UTF-8");
                // Fix bug with FCKEditor saving strange BR types
                $oQuotaLanguageSetting->quotals_message = fixCKeditorText($oQuotaLanguageSetting->quotals_message);

                $oQuotaLanguageSetting->save(false);
                if (!$oQuotaLanguageSetting->validate()) {
                    $oQuota->addErrors($oQuotaLanguageSetting->getErrors());
                }
            }
            //delete quota and language settings for this qouta if errors
            if ($oQuota->getErrors()) {
                //delete quotalanguagesettings if any for this qouta
                foreach ($oQuota->languagesettings as $languageSetting) {
                    $languageSetting->delete();
                }
                $oQuota->delete();
            }
        }

        return $oQuota;
    }

    /**
     *
     * @param \Quota $oQuota
     * @param array $quotaParams
     * @return bool|mixed
     */
    public function editQuota($oQuota, array $quotaParams)
    {
        $oQuota->attributes = $quotaParams;
        if ($oQuota->save()) {
            foreach ($_POST['QuotaLanguageSetting'] as $language => $settingAttributes) {
                $oQuotaLanguageSetting = $oQuota->languagesettings[$language];
                $oQuotaLanguageSetting->attributes = $settingAttributes;

                //Clean XSS - Automatically provided by CI
                $oQuotaLanguageSetting->quotals_message = html_entity_decode($oQuotaLanguageSetting->quotals_message, ENT_QUOTES, "UTF-8");
                // Fix bug with FCKEditor saving strange BR types
                $oQuotaLanguageSetting->quotals_message = fixCKeditorText($oQuotaLanguageSetting->quotals_message);

                if (!$oQuotaLanguageSetting->save()) {
                    $oQuota->addErrors($oQuotaLanguageSetting->getErrors());
                }
            }
        }

        return $oQuota;
    }

    /**
     * Retunr
     *
     * @param \Quota $oQuota
     * @param $language
     * @return \QuotaLanguageSetting
     */
    public function newQuotaLanguageSetting(\Quota $oQuota, $language)
    {
        $oQuotaLanguageSetting = new \QuotaLanguageSetting();
        $oQuotaLanguageSetting->quotals_name = $oQuota->name;
        $oQuotaLanguageSetting->quotals_quota_id = $oQuota->primaryKey;
        $oQuotaLanguageSetting->quotals_language = $language;
        $oQuotaLanguageSetting->quotals_url = $this->survey->languagesettings[$language]->surveyls_url;
        $siteLanguage = \Yii::app()->language;
        // Switch language temporarily to get the default text in right language
        \Yii::app()->language = $language;
        $oQuotaLanguageSetting->quotals_message = gT("Sorry your responses have exceeded a quota on this survey.");
        \Yii::app()->language = $siteLanguage;

        return $oQuotaLanguageSetting;
    }

    /**
     * Checks if all possible answers are already selected.
     *
     * @param \Question $oQuestion
     * @param array $aQuestionAnswers  array list with possible question answers
     *                                  and already used answers (see getQuotaAnswer)
     * @return bool true if all possible answers are alreday selected, false otherwise
     */
    public function allAnswersSelected(\Question $oQuestion, array $aQuestionAnswers)
    {
        $cntQuestionAnswer = 0;
        foreach ($aQuestionAnswers as $aQACheck) {
            if (isset($aQACheck['rowexists'])) {
                $cntQuestionAnswer++;
            }
        }

        return ($oQuestion->type != "*" && count($aQuestionAnswers) == $cntQuestionAnswer);
    }

    /**
     *
     * @param $aQuotaIds
     * @param $action
     * @param $languageSettings
     * @return null | array errors or null if no errors
     * @throws \CDbException
     */
    public function multipleItemsAction($aQuotaIds, $action, $languageSettings = [])
    {
        $errors = null;
        foreach ($aQuotaIds as $iQuotaId) {
            /** @var \Quota $oQuota */
            $oQuota = \Quota::model()->findByPk($iQuotaId);
            switch ($action) {
                case 'activate':
                case 'deactivate':
                    $oQuota->active = ($action == 'activate' ? 1 : 0);
                    if (!$oQuota->save()) {
                        $errors[] = $oQuota->errors;
                    }
                    break;
                case 'delete':
                    $oQuota->delete();
                    \QuotaLanguageSetting::model()->deleteAllByAttributes(array('quotals_quota_id' => $iQuotaId));
                    \QuotaMember::model()->deleteAllByAttributes(array('quota_id' => $iQuotaId));
                    break;
                case 'changeLanguageSettings':
                    if (!empty($languageSettings)) {
                        $oQuotaLanguageSettings = $oQuota->languagesettings;
                        foreach ($_POST['QuotaLanguageSetting'] as $language => $aQuotaLanguageSettingAttributes) {
                            $oQuotaLanguageSetting = $oQuota->languagesettings[$language];
                            $oQuotaLanguageSetting->attributes = $aQuotaLanguageSettingAttributes;
                            if (!$oQuotaLanguageSetting->save()) {
                                // save errors
                                $oQuotaLanguageSettings[$language] = $oQuotaLanguageSetting;
                                $errors[] = $oQuotaLanguageSetting->errors;
                            }
                        }
                    }
                    break;
                default:
                    $errors [] = 'No valid action';
            }
        }

        return $errors;
    }

    /**
     * Checks for a specific action if current user has the permission for it.
     *
     * @param $action
     * @return bool true if user has permission for action, false otherwise
     */
    public function checkActionPermissions($action)
    {
        switch ($action) {
            case 'activate':
            case 'deactivate':
            case 'changeLanguageSettings':
                $permissionOk = \Permission::model()->hasSurveyPermission($this->survey->sid, 'quotas', 'update');
                break;
            case 'delete':
                $permissionOk = \Permission::model()->hasSurveyPermission(
                    $this->survey->sid,
                    'quotas',
                    'delete'
                );
                break;
            default:
                $permissionOk = false;
        }
        return $permissionOk;
    }
}