codeformunich/Muenchen-Transparent

View on GitHub
protected/models/BenutzerIn.php

Summary

Maintainability
D
2 days
Test Coverage
<?php

use JetBrains\PhpStorm\ArrayShape;

/**
 * @property integer $id
 * @property string $email
 * @property integer $email_bestaetigt
 * @property string $datum_angelegt
 * @property string $pwd_enc
 * @property string $pwd_change_date
 * @property string $pwd_change_code
 * @property string $einstellungen
 * @property string $datum_letzte_benachrichtigung
 * @property int $berechtigungen_flags
 *
 * @property Vorgang[] $abonnierte_vorgaenge
 * @property StadtraetIn[] $stadtraetInnen
 */
class BenutzerIn extends CActiveRecord
{
    // Hinweis: Müssen 2er-Potenzen sein, also 32, 64, 128, ...
    public const BERECHTIGUNG_USER = 1;
    public const BERECHTIGUNG_CONTENT = 2;
    public const BERECHTIGUNG_TAG = 4;
    public const BERECHTIGUNGEN = [
        1 => "User-Admin",
        2 => "Content-Admin",
        4 => "Tag-Admin",
    ];

    private ?BenutzerInnenEinstellungen $einstellungen_object = null;


    /**
     * @return BenutzerIn[]
     */
    public static function alleAktiveAccounts()
    {
        return BenutzerIn::model()->findAllByAttributes(["email_bestaetigt" => "1"], ["order" => "email"]);
    }

    public static function createBenutzerIn(string $email, string $password = ""): BenutzerIn
    {
        $benutzerIn = new BenutzerIn;
        $benutzerIn->email = $email;
        $benutzerIn->email_bestaetigt = 0;
        $benutzerIn->pwd_enc = ($password != "" ? BenutzerIn::create_hash($password) : "");
        $benutzerIn->datum_angelegt = new CDbExpression("NOW()");
        $benutzerIn->datum_letzte_benachrichtigung = new CDbExpression("NOW()");
        return $benutzerIn;
    }

    /**
     * @param string $className active record class name.
     * @return BenutzerIn the static model class
     */
    public static function model($className = __CLASS__)
    {
        return parent::model($className);
    }

    /**
     * @return string
     */
    public function tableName()
    {
        return 'benutzerInnen';
    }


    /**
     * @return array
     */
    public function rules()
    {
        $rules = [
            ['email, datum_angelegt', 'required'],
            ['id, email_bestaetigt, berechtigungen_flags', 'numerical', 'integerOnly' => true],
            ['datum_letzte_benachrichtigung', 'default', 'setOnEmpty' => true, 'value' => null],
        ];
        return $rules;
    }

    /**
     * @return array
     */
    public function relations()
    {
        return [
            'abonnierte_vorgaenge' => [self::MANY_MANY, 'Vorgang', 'benutzerInnen_vorgaenge_abos(benutzerInnen_id, vorgaenge_id)'],
            'stadtraetInnen' => [self::HAS_MANY, 'StadtraetIn', 'benutzerIn_id'],
        ];
    }

    /**
     * @return array
     */
    public function attributeLabels()
    {
        return [
            'id' => Yii::t('app', 'ID'),
            'email' => Yii::t('app', 'E-Mail'),
            'email_bestaetigt' => Yii::t('app', 'E-Mail-Adresse bestätigt'),
            'pwd_enc' => Yii::t('app', 'Passwort-Hash'),
            'pwd_change_date' => Yii::t('app', 'Passwort-Änderung: Datum'),
            'pwd_change_code' => Yii::t('app', 'Passwort-Änderung: Code'),
            'datum_angelegt' => Yii::t('app', 'Angelegt Datum'),
            'datum_letzte_benachrichtigung' => Yii::t('app', 'Datum der letzten Benachrichtigung'),
            'einstellungen' => null,
            'abonnierte_vorgaenge' => Yii::t('app', 'Abonnierte Vorgänge'),
            'berechtigungen_flags' => 'Berechtigungen',
        ];
    }

    /**
     * @param int $n
     * @return string
     */
    public static function label($n = 1)
    {
        return Yii::t('app', 'BenutzerIn|BenutzerInnen', $n);
    }


    public static function createPassword(): string
    {
        $chars = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789';
        $max = strlen($chars) - 1;
        $pw = "";
        for ($i = 0; $i < 8; $i++) $pw .= $chars[rand(0, $max)];
        return $pw;
    }

    /**
     * @param string $date
     * @return string
     */
    public function createEmailBestaetigungsCode($date = "")
    {
        if ($date == "") $date = date("Ymd");
        $code = $this->id . "-" . substr(md5($this->id . $date . SEED_KEY), 0, 8);
        return $code;
    }

    /**
     * @param string $code
     * @return bool
     */
    public function checkEmailBestaetigungsCode($code)
    {
        if ($code == $this->createEmailBestaetigungsCode()) return true;
        if ($code == $this->createEmailBestaetigungsCode(date("Ymd", time() - 24 * 3600))) return true;
        if ($code == $this->createEmailBestaetigungsCode(date("Ymd", time() - 2 * 24 * 3600))) return true;
        return false;
    }

    public function sendEmailBestaetigungsMail(): void
    {
        $best_code = $this->createEmailBestaetigungsCode();
        $link = Yii::app()->getBaseUrl(true) . Yii::app()->createUrl("index/benachrichtigungen", ["code" => $best_code]);
        RISTools::send_email($this->email, "Anmeldung bei München Transparent", "Hallo,\n\num deine E-Mail-Adresse zu bestätigen und E-Mail-Benachrichtigungen von München Transparent zu erhalten, klicke bitte auf folgenden Link:\n$link\n\n"
            . "Liebe Grüße,\n\tDas München Transparent-Team.", null, "email");
    }

    public function emailBestaetigen(string $code): bool
    {
        if (!$this->checkEmailBestaetigungsCode($code)) return false;
        if ($this->pwd_enc == "") $this->pwd_enc = BenutzerIn::create_hash($code);
        $this->email_bestaetigt = 1;
        return $this->save();
    }

    public function getBenachrichtigungAbmeldenCode(): string
    {
        return $this->id . "-" . substr(md5($this->id . "abmelden" . SEED_KEY), 0, 8);
    }


    /**
     * @return bool|string
     */
    public function resetPasswordStart()
    {
        if ($this->pwd_change_date !== null) {
            $ts = RISTools::date_iso2timestamp($this->pwd_change_date);
            if (time() - $ts < 3600 * 24) return "Es kann nur eine Passwortänderung innerhalb von 24 Stunden beantragt werden.";
        }
        $this->pwd_change_code = sha1(uniqid() . $this->pwd_enc);
        $this->pwd_change_date = new CDbExpression("NOW()");
        if ($this->save()) {
            $link = Yii::app()->getBaseUrl(true) . Yii::app()->createUrl("benachrichtigungen/NeuesPasswortSetzen", ["id" => $this->id, "code" => $this->pwd_change_code]);
            RISTools::send_email($this->email, "Passwort zurücksetzen", "Hallo,\n\num ein neues Passwort für deinen Zugang bei München Transparent zu setzen, klicke bitte auf folgenden Link:\n$link\n\n"
                . "Liebe Grüße,\n\tDas München Transparent-Team.", null, "password");
            return true;
        }
        return "Ein (ungewöhnlicher) Fehler ist aufgetreten.";
    }

    /**
     * @param string $code
     * @param string $new_pw
     * @return string|bool
     */
    public function resetPasswordDo($code, $new_pw)
    {
        if ($this->pwd_change_date === null) return "Es wurde keine Passwortänderung beantragt.";
        $ts = RISTools::date_iso2timestamp($this->pwd_change_date);
        if (time() - $ts > 3600 * 24) return "Der Antrag liegt bereits mehr als 24 Stunden zurück. Bitte stelle einen neuen Passwort-Änderungs-Antrag.";
        if ($this->pwd_change_code != $code) return "Der Link bzw. Code ist ungültig.";
        $this->pwd_enc = BenutzerIn::create_hash($new_pw);
        $this->pwd_change_code = null;
        $this->save();
        return true;
    }

    /**
     * @param string $new_pw
     * @throws Exception
     */
    public function setPassword($new_pw)
    {
        if (!defined("SITE_CALL_MODE") || SITE_CALL_MODE !== "shell") {
            throw new Exception("Diese Funktion kann nur über die Kommandozeile aufgerufen werden.");
        }
        $this->pwd_enc = BenutzerIn::create_hash($new_pw);
        $this->save(false);
    }

    public function getEinstellungen(): BenutzerInnenEinstellungen
    {
        if (!is_object($this->einstellungen_object)) $this->einstellungen_object = new BenutzerInnenEinstellungen($this->einstellungen);
        return $this->einstellungen_object;
    }

    public function setEinstellungen(BenutzerInnenEinstellungen $einstellungen): void
    {
        $this->einstellungen_object = $einstellungen;
        $this->einstellungen = $einstellungen->toJSON();
    }

    /**
     * @return RISSucheKrits[]
     */
    public function getBenachrichtigungen(): array
    {
        $arr = [];
        $einstellungen = $this->getEinstellungen();
        foreach ($einstellungen->benachrichtigungen as $krit) $arr[] = new RISSucheKrits($krit);
        return $arr;
    }

    /**
     * @param RISSucheKrits $krits
     */
    public function addBenachrichtigung($krits)
    {
        if ($krits->getBenachrichtigungKrits()->krits == [])
            return;

        $einstellungen = $this->getEinstellungen();
        foreach ($einstellungen->benachrichtigungen as $ben) {
            if ($ben == $krits->krits) return;
        }
        $einstellungen->benachrichtigungen[] = $krits->getBenachrichtigungKrits()->krits;
        $this->setEinstellungen($einstellungen);
        $this->save();
    }

    /**
     * @return boolean wether the krit was really deleted
     */
    public function delBenachrichtigung(RISSucheKrits $krits): bool
    {
        $was_deleted = false;
        $einstellungen = $this->getEinstellungen();
        $neue = [];
        foreach ($einstellungen->benachrichtigungen as $ben) {
            if ($krits->krits != $ben) {
                $neue[] = $ben;
            } else {
                $was_deleted = true;
            }
        }
        $einstellungen->benachrichtigungen = $neue;
        $this->setEinstellungen($einstellungen);
        $this->save();
        return $was_deleted;
    }

    public function wirdBenachrichtigt(RISSucheKrits $krits): bool
    {
        $suchkrits = $krits->getBenachrichtigungKrits();
        $einstellungen = $this->getEinstellungen();
        foreach ($einstellungen->benachrichtigungen as $ben) if ($suchkrits->krits == $ben) return true;
        return false;
    }


    /**
     * @return BenutzerIn[]
     */
    public static function heuteZuBenachrichtigendeBenutzerInnen()
    {
        /** @var BenutzerIn[] $benutzerInnen */
        $benutzerInnen = BenutzerIn::model()->findAllByAttributes(["email_bestaetigt" => 1]);
        $todo = [];
        foreach ($benutzerInnen as $benutzerIn) {
            $wochentag = $benutzerIn->getEinstellungen()->benachrichtigungstag;
            if ($wochentag === null || $wochentag == date("w")) $todo[] = $benutzerIn;
        }
        return $todo;
    }

    /**
     * @param int[] $document_ids
     */
    public function queryBenachrichtigungen(array $document_ids, RISSucheKrits $benachrichtigung): array
    {
        $solr = RISSolrHelper::getSolrClient();

        $select = $solr->createSelect();

        $select->addSort('sort_datum', $select::SORT_DESC);
        $select->setRows(100);

        $dismax = $select->getDisMax();
        $dismax->setQueryParser('edismax');
        $dismax->setQueryFields("text text_ocr");

        $select->setQuery($benachrichtigung->getSolrQueryStr($select));

        $select->createFilterQuery('maxprice')->setQuery(implode(" OR ", $document_ids));

        $hl = $select->getHighlighting();
        $hl->setFields('text, text_ocr, antrag_betreff');
        $hl->setSimplePrefix('<b>');
        $hl->setSimplePostfix('</b>');

        $ergebnisse = $solr->select($select);
        /** @var RISSolrDocument[] $documents */
        $documents = $ergebnisse->getDocuments();
        $res = [];
        foreach ($documents as $document) {
            $res[] = [
                "id" => $document->id,
                "name" => $document->dokument_name . ", " . $document->antrag_betreff,
            ];
        }
        return $res;
    }

    #[ArrayShape(["antraege" => "array", "termine" => "array", "vorgaenge" => "array"])]
    public function benachrichtigungsErgebnisse(int $zeitspanne): array
    {
        $benachrichtigungen = $this->getBenachrichtigungen();

        if ($zeitspanne > 0) {
            $neu_seit_ts = time() - $zeitspanne * 24 * 3600;
            $neu_seit = date("Y-m-d H:i:s", $neu_seit_ts);
        } else {
            $neu_seit = $this->datum_letzte_benachrichtigung;
            $neu_seit_ts = RISTools::date_iso2timestamp($neu_seit);
        }

        $ergebnisse = [
            "antraege" => [],
            "termine" => [],
            "vorgaenge" => [],
        ];

        $sql = Yii::app()->db->createCommand();
        $sql->select("id")->from("dokumente")->where("datum >= '" . addslashes($neu_seit) . "'");
        $data = $sql->queryColumn();
        if (count($data) > 0) {

            $document_ids = [];
            foreach ($data as $did) $document_ids[] = "id:\"Document:$did\"";

            foreach ($benachrichtigungen as $benachrichtigung) {
                $e = $this->queryBenachrichtigungen($document_ids, $benachrichtigung);
                foreach ($e as $f) {
                    $d = explode(":", $f["id"]);
                    $dokument_id = IntVal($d[1]);
                    $dokument = Dokument::getCachedByID($dokument_id);
                    if (!$dokument) continue;
                    if ($dokument->antrag_id > 0) {
                        if (!isset($ergebnisse["antraege"][$dokument->antrag_id])) {
                            $ergebnisse["antraege"][$dokument->antrag_id] = [
                                "antrag" => $dokument->antrag,
                                "dokumente" => []
                            ];
                        }
                        if (!isset($ergebnisse["antraege"][$dokument->antrag_id]["dokumente"][$dokument_id])) {
                            $ergebnisse["antraege"][$dokument->antrag_id]["dokumente"][$dokument_id] = [
                                "dokument" => Dokument::model()->findByPk($dokument_id),
                                "queries" => []
                            ];
                        }
                        $ergebnisse["antraege"][$dokument->antrag_id]["dokumente"][$dokument_id]["queries"][] = $benachrichtigung;
                    } elseif ($dokument->termin_id > 0) {
                        if (!isset($ergebnisse["termine"][$dokument->termin_id])) {
                            $ergebnisse["termine"][$dokument->termin_id] = [
                                "termin" => $dokument->termin,
                                "dokumente" => []
                            ];
                        }
                        if (!isset($ergebnisse["termine"][$dokument->termin_id]["dokumente"][$dokument_id])) {
                            $ergebnisse["termine"][$dokument->termin_id]["dokumente"][$dokument_id] = [
                                "dokument" => Dokument::model()->findByPk($dokument_id),
                                "queries" => []
                            ];
                        }
                        $ergebnisse["termine"][$dokument->termin_id]["dokumente"][$dokument_id]["queries"][] = $benachrichtigung;
                    }
                }
            }
        }

        foreach ($this->abonnierte_vorgaenge as $vorgang) {
            foreach ($vorgang->antraege as $ant) {
                if (RISTools::date_iso2timestamp($ant->datum_letzte_aenderung) < $neu_seit_ts) continue;
                if (!isset($ergebnisse["vorgaenge"][$vorgang->id])) $ergebnisse["vorgaenge"][$vorgang->id] = ["vorgang" => $vorgang->wichtigstesRisItem()->getName(true), "neues" => []];
                $ant->findeAenderungen(time());
                $ergebnisse["vorgaenge"][$vorgang->id]["neues"][] = $ant;
            }
            foreach ($vorgang->dokumente as $dok) {
                if (RISTools::date_iso2timestamp($dok->datum) < $neu_seit_ts) continue;
                if (!isset($ergebnisse["vorgaenge"][$vorgang->id])) $ergebnisse["vorgaenge"][$vorgang->id] = ["vorgang" => $vorgang->wichtigstesRisItem()->getName(true), "neues" => []];
                $ergebnisse["vorgaenge"][$vorgang->id]["neues"][] = $dok;
            }
            foreach ($vorgang->ergebnisse as $erg) {
                if (RISTools::date_iso2timestamp($erg->datum_letzte_aenderung) < $neu_seit_ts) continue;
                if (!isset($ergebnisse["vorgaenge"][$vorgang->id])) $ergebnisse["vorgaenge"][$vorgang->id] = ["vorgang" => $vorgang->wichtigstesRisItem()->getName(true), "neues" => []];
                $ergebnisse["vorgaenge"][$vorgang->id]["neues"][] = $erg;
            }
        }

        return $ergebnisse;
    }


    /**
     * @param string $code
     * @return BenutzerIn|null
     */
    public static function getByFeedCode($code)
    {
        $x = explode("-", $code);
        if (count($x) != 2) return null;
        /** @var BenutzerIn $benutzerIn */
        $benutzerIn = BenutzerIn::model()->findByPk($x[0]);
        if (!$benutzerIn) return null;
        elseif ($code == $benutzerIn->getFeedCode()) return $benutzerIn;
        else return null;
    }

    /**
     * @return string
     */
    public function getFeedCode()
    {
        return $this->id . "-" . substr(md5(SEED_KEY . $this->pwd_enc), 0, 10);
    }


    /**
     * @static
     * @param string $password
     * @return string
     */
    public static function create_hash($password)
    {
        return password_hash($password, PASSWORD_DEFAULT);
    }


    /**
     * @param string $password
     * @return bool
     */
    public function validate_password($password)
    {
        return password_verify($password, $this->pwd_enc);
    }

    /**
     * @param int $berechtigung
     */
    public function setzeBerechtigung($berechtigung)
    {
        $this->berechtigungen_flags = $this->berechtigungen_flags | $berechtigung;
        $this->save();
    }

    /**
     * @param int $berechtigung
     */
    public function entferneBerechtigung($berechtigung)
    {
        $this->berechtigungen_flags = $this->berechtigungen_flags & ~$berechtigung;
        $this->save();
    }

    /**
     * @param int $berechtigung
     * @return bool
     */
    public function hatBerechtigung($berechtigung)
    {
        return (($this->berechtigungen_flags & $berechtigung) == $berechtigung);
    }

    /**
     * @return bool
     */
    public function hatIrgendeineBerechtigung()
    {
        return $this->berechtigungen_flags != 0;
    }

}