Identity.php

<?php

/*
 * This file is part of rap
 * Copyright (C) 2016 Istituto Nazionale di Astrofisica
 * SPDX-License-Identifier: GPL-3.0-or-later
 */

namespace RAP;

/**
 * Data model for identities.
 */
class Identity {

    const EDU_GAIN = "eduGAIN";
    const X509 = "X.509";
    const GOOGLE = "Google";
    const LINKEDIN = "LinkedIn";
    const ORCID = "OrcID";

    private static $ALLOWED_TYPES = [Identity::EDU_GAIN, Identity::X509, Identity::GOOGLE, Identity::LINKEDIN, Identity::ORCID];

    /**
     * Identity id in the database. Mandatory field.
     */
    public $id;

    /**
     * One of the types specified above. Mandatory field.
     */
    public $type;

    /**
     * Data related to specific account type (shibboleth persistent id, 
     * certificate serial number, etc, ...). Mandatory field.
     */
    public $typedId;

    /**
     * Primary email related to this identity. Mandatory field.
     * @todo Maybe an user can have additional email addresses (e.g.: Google
     * API provides them). Should we store them somewhere?
     */
    public $email;

    /**
     * First name.
     * This should be mandatory, however for old IA2 users we have only email address.
     */
    public $name;

    /**
     * Last name / Family name
     * This should be mandatory, however for old IA2 users we have only email address.
     */
    public $surname;

    /**
     * Institution / Organization. Not mandatory.
     */
    public $institution;

    /**
     * For eduGAIN identities.
     * This is currently the same as the typedId for eduGAIN identity types, because
     * at IA2 we need this (see the wiki). Use the Shibboleth persistent id should
     * be a more appropriate typedId for these cases.
     */
    public $eppn;

    /**
     * True if this has been selected as the primary identity.
     */
    public $primary;

    public function __construct($userType) {
        $isAllowedType = false;
        foreach (Identity::$ALLOWED_TYPES as $type) {
            if ($userType === $type) {
                $isAllowedType = true;
                break;
            }
        }
        if (!$isAllowedType) {
            throw new \Exception($userType . " is not a supported user type");
        }

        $this->type = $userType;

        $this->primary = false;
    }

    private static function endsWith($haystack, $needle) {
        return substr($haystack, -strlen($needle)) === $needle;
    }

    /**
     * Workaround for IA2 users
     */
    public function getUIType() {
        if ($this->eppn !== null && $this->endsWith($this->eppn, '@ia2.inaf.it')) {
            return 'IA2';
        } else {
            return $this->type;
        }
    }

}