CMS-CSE/core/class/git.class.php

<?php

/**
 * Classe git
 * 
 * Cette classe fournit des méthodes pour interagir avec Git, telles que la récupération
 * des informations de commit, de branche et l'affichage des versions.
 */
class git
{
    /**
     * Vérifie si une chaîne contient une erreur Git.
     *
     * @param string|null $_string Chaîne à vérifier (facultatif).
     * @return bool Retourne TRUE si aucune erreur n'est détectée, FALSE sinon.
     */
    public static function checkError(?string $_string = NULL)
    {
        $return = NULL;
        if ($_string != NULL) {
            if (strpos($_string, '-// SUCCESS //-') === TRUE) {
                $return = TRUE;
            } else {
                return FALSE;
            }

            return $return;
        } else {
            return TRUE;
        }
    }

    /**
     * Récupère le hash du dernier commit pour une cible donnée.
     *
     * @param string|null $_target Cible Git (par défaut HEAD).
     * @return string Retourne les 10 premiers caractères du hash du commit.
     */
    public static function getCommitHash($_target = NULL)
    {
        if ($_target == NULL) {
            // Commit local HEAD
            $cmd = 'git log --pretty="%H" -n1 HEAD';
            $output = [];
            $retval = 0;
            $result = exec($cmd, $output, $retval);
            return substr(trim($result), 0, 10);
        } else {
            // Hash du commit distant en temps réel
            $cmd = 'git ls-remote origin "refs/heads/' . $_target . '"';
            $output = [];
            $retval = 0;
            $result = exec($cmd, $output, $retval);
            // $result ou $output[0] = "<hash>\trefs/heads/branch"
            $hash = '';
            if (!empty($output) && strpos($output[0], '\t') !== false) {
                $hash = explode("\t", $output[0])[0];
            }
            return substr(trim($hash), 0, 10);
        }
    }

    /**
     * Récupère la date du dernier commit pour une cible donnée.
     *
     * @param string|null $_target Cible Git (par défaut HEAD).
     * @return string Retourne la date du commit formatée (d/m/Y à H:i:s).
     */
    public static function getCommitDate($_target = NULL)
    {
        if ($_target == NULL) {
            $target = "HEAD";
        } else {
            $target = "origin/" . $_target;
        }
        $commitDate = new \DateTime(trim(exec('git log -n1 --pretty=%ci ' . $target)));
        $commitDate->setTimezone(new \DateTimeZone('Europe/Paris'));
        return $commitDate->format('d/m/Y à H:i:s');
    }

    /**
     * Récupère l'auteur du dernier commit pour une cible donnée.
     *
     * @param string|null $_target Cible Git (par défaut HEAD).
     * @return string Retourne le nom de l'auteur du commit.
     */
    public static function getCommitAuthor($_target = NULL)
    {
        if ($_target == NULL) {
            $target = "HEAD";
        } else {
            $target = "origin/" . $_target;
        }
        return exec('git log --pretty="%cn" -n1 ' . $target);
    }

    /**
     * Récupère le message du dernier commit pour une cible donnée.
     *
     * @param string|null $_target Cible Git (par défaut HEAD).
     * @return string Retourne le message du commit.
     */
    public static function getCommitName($_target = NULL)
    {
        if ($_target == NULL) {
            $target = "HEAD";
        } else {
            $target = "origin/" . $_target;
        }
        return exec('git log --pretty="%s" -n1 ' . $target);
    }

    /**
     * Récupère le nom de la branche actuelle ou d'une cible donnée.
     *
     * @param string|null $_target Cible Git (facultatif).
     * @return string Retourne le nom de la branche.
     */
    public static function getBranchName($_target = NULL)
    {
        if ($_target == NULL) {
            return exec('git rev-parse --abbrev-ref HEAD');
        } else {
            return $_target;
        }
    }

    /**
     * Affiche les informations de version pour une cible donnée.
     *
     * @param string|null $_target Cible Git (facultatif).
     * @return void
     */
    public static function printVersion($_target = NULL)
    {
        echo sprintf(
            '<h6>%s <span class="badge bg-info">%s</span> <span class="badge bg-success">%s</span></h6>
            <code>%s</code>
            <div class="media-body pb-3 mb-0 small lh-125">Le %s</div>',
            self::getCommitAuthor($_target),
            self::getBranchName($_target),
            self::getCommitHash($_target),
            self::getCommitName($_target),
            self::getCommitDate($_target)
        );
    }
}