source: spip-zone/_plugins_/coloration_code/trunk/coloration_code_fonctions.php @ 71540

<?php
/**
 * Plugin coloration code
 * Fonctions spécifiques au plugin
 * 
 * @package SPIP\Coloration_code\Fonctions
 */
 
if (!defined("_ECRIRE_INC_VERSION")) return;

// pour interdire globalement et optionnellement le téléchargement associé
if (!defined('PLUGIN_COLORATION_CODE_TELECHARGE')) {
        define('PLUGIN_COLORATION_CODE_TELECHARGE', true);
}

// pour utiliser des styles inline (ou des classes css)
if (!defined('PLUGIN_COLORATION_CODE_STYLES_INLINE')) {
        define('PLUGIN_COLORATION_CODE_STYLES_INLINE', true); // false mettra des class et une css associe
}

// pour mettre des classes css MAIS ne mettre aucun style correspondant
// cela suppose donc qu'une CSS externe a ce plugin s'occupe de les styler
if (!defined('PLUGIN_COLORATION_CODE_SANS_STYLES')) {
        define('PLUGIN_COLORATION_CODE_SANS_STYLES', false); // true mettra des class mais pas de css associe
}

// pouvoir definir la taille des tablations (defaut de geshi : 8)
// define('PLUGIN_COLORATION_CODE_TAB_WIDTH', 4);

// Liens externes sur les mots cles de langage (defaut de geshi : true)
if (!defined('PLUGIN_COLORATION_CODE_LIENS_LANGAGE')) {
        define('PLUGIN_COLORATION_CODE_LIENS_LANGAGE', true); // false pour les eviter
}


// pour utiliser le colorieur 'spip' ou 'spip2' si on
// passe une class "spip" simplement.
// note: le colorieur "spip" est celui present originellement dans le plugin
// mais possede des regexp qui se trompaient parfois à quelques } ou > pres...
// il est laisse pour ceux qui le preferaient neanmoins (le nouveau n'a pas les memes couleurs).
if (!defined('PLUGIN_COLORATION_CODE_COLORIEUR_SPIP')) {
        define('PLUGIN_COLORATION_CODE_COLORIEUR_SPIP', 'spip2');
}


function coloration_code_color($code, $language, $cadre='cadre', $englobant='div') {

        // On ajoute une argument a la fonction pour permettre d'afficher du code dans des <span>
        // plutot que dans un <div>. Par contre, cette option de span est a utiliser avec la balise <code>
        // et pas <cadre> pour des raisons de validite et de presentation.
        // En outre, le bouton telecharger n'est pas affiche.
        if ($cadre == 'cadre')
                $englobant = 'div';

        // Supprime le premier et le dernier retour chariot
        $code = preg_replace("/^(\r\n|\n|\r)*/", "", $code);
        $code = preg_replace("/(\r\n|\n|\r)*$/", "", $code);

        $params = explode(' ', $language);
        $language = array_shift($params);
        
        if ($language=='spip') $language = PLUGIN_COLORATION_CODE_COLORIEUR_SPIP;
        
        include_spip('inc/spip_geshi');
        //
        // Create a GeSHi object
        //
        $geshi = new SPIP_GeSHi($code, $language);
        if ($geshi->error()) {
                return false;
        }
        global $spip_lang_right;
        
        // eviter des ajouts abusifs de CSS par Geshy 
        // qui pose des 'font-family: monospace;' un peu partout
        // et que FF ne gere pas comme les autres navigateurs (va comprendre).
        $geshi->set_overall_style('');
        $geshi->set_code_style('');
        
        $stylecss = "";
        if (!PLUGIN_COLORATION_CODE_STYLES_INLINE OR PLUGIN_COLORATION_CODE_SANS_STYLES) {
                $geshi->enable_classes();
                if (!PLUGIN_COLORATION_CODE_SANS_STYLES) {
                        $stylecss = "<style type='text/css'>".$geshi->get_stylesheet()."</style>";
                }
        }


        if (defined('PLUGIN_COLORATION_CODE_TAB_WIDTH') and PLUGIN_COLORATION_CODE_TAB_WIDTH) {
                $geshi->set_tab_width(PLUGIN_COLORATION_CODE_TAB_WIDTH);
        }

        // permettre de supprimer les liens vers les documentations sur les mots cles de langage
        if (!PLUGIN_COLORATION_CODE_LIENS_LANGAGE) {
                $geshi->enable_keyword_links(false);
        }

        include_spip('inc/texte');
        $code = echappe_retour($code);

        $telecharge = ($englobant == 'div')
         &&     (PLUGIN_COLORATION_CODE_TELECHARGE || in_array('telechargement', $params))
         && (strpos($code, "\n") !== false) && !in_array('sans_telechargement', $params);
        if ($telecharge) {
                // Gerer le fichier contenant le code au format texte
                $nom_fichier = md5($code);
                $dossier = sous_repertoire(_DIR_VAR, 'cache-code');
                $fichier = "$dossier$nom_fichier.txt";

                if (!file_exists($fichier)) {
                        ecrire_fichier($fichier, $code);
                }
        }

        /**
         * On insère un attribut data-clipboard-text si on n'a pas le lien de téléchargement car pas de saut de ligne
         */
        $datatext = !$telecharge && PLUGIN_COLORATION_CODE_TELECHARGE;
        if($datatext)
                $datatext_content = ' data-clipboard-text="'.attribut_html($code).'"';
                
        if ($cadre == 'cadre') {
          $spip_cadre = ' spip_cadre';
          $geshi->set_header_type(GESHI_HEADER_DIV);
          $geshi->enable_line_numbers(GESHI_NORMAL_LINE_NUMBERS);
        } else {
          $spip_cadre = '';
          $geshi->set_header_type(GESHI_HEADER_NONE);
          $geshi->enable_line_numbers(GESHI_NO_LINE_NUMBERS);
        }

        //
        // And echo the result!
        //
        $rempl = $stylecss . '<' . $englobant . ' class="coloration_code"><' . $englobant . ' class="spip_'.$language.' '.$cadre.$spip_cadre.'"'.$datatext_content.'>'.$geshi->parse_code().'</' . $englobant . '>';

        if ($telecharge) {
                $rempl .= "<div class='" . $cadre . "_download'><a href='$fichier'>"._T('bouton_download')."</a></div>";
        }
        return $rempl.'</' . $englobant . '>';
}

/**
 * Est-ce à Geshi de traiter les codes et cadres ou on utilise les fonctions natives de SPIP
 * 
 * @param array $regs
 * @return string $ret
 */
function cadre_ou_code($regs) {
        // pour l'instant, on oublie $matches[1] et $matches[4] les attributs autour de class="machin"
        if (preg_match(',^(.*)class=("|\')(.*)\2(.*)$,Uims',$regs[2], $matches)){
                $englobant = "div";
                if ($regs[1]=="code" AND strpos($regs[3],"\n")===false)
                        $englobant = "span";
                if ($ret = coloration_code_color($regs[3], $matches[3], $regs[1], $englobant))
                        return $ret;
        }

        if ($regs[1] == 'code')
                return traiter_echap_code_dist($regs);

        return traiter_echap_cadre_dist($regs);
}

/**
 * Surcharge de la fonction traiter_echap_code_dist native de SPIP 
 * cf : ecrire/inc/texte_mini
 * 
 * @param array $regs
 * @return string 
 */
function traiter_echap_code($regs) {
        return cadre_ou_code($regs);
}

/**
 * Surcharge de la fonction traiter_echap_cadre_dist native de SPIP 
 * cf : ecrire/inc/texte_mini
 * 
 * @param array $regs
 * @return string 
 */
function traiter_echap_cadre($regs) {
        return cadre_ou_code($regs);
}