Una piccola aggiunta al Disqus Helper di ToX

Qualche tempo fa il buon Emanuele Toscano ha pubblicato un comodissimo helper per integrare in cakephp il servizio di commenti Disqus.

Ho avuto finalmente occasione di provarlo – il servizio è fatto bene e offre, anche nella versione gratuita, tutta una serie di cose già pronte che permettono di risparmiare un sacco di tempo (funzione “mi piace”, condividi con facebook o con twitter, moderazione / controllo spam e tante altre piccole opzioni).

L’helper di ToX permette di implementarlo -letteralmente- in cinque minuti.

Lo svantaggio del servizio esterno ovviamente è quello di una minore integrazione rispetto ad un sistema di commenti proprio.
Ad esempio, la mail di notifica di inserimento di un nuovo commento arriva solo al “proprietario”, che va bene per un blog personale ma non per un cms multiutente – L’autore del singolo contenuto non saprà che è stato commentato..
Oppure, per vari motivi, può essere utile sincronizzare i commenti di disqus con quelli nel database della propria applicazione.

Qui Disqus offre dei ganci – nella forma di una API completa o più semplicemente una callback molto utile per l’installazione standard – proprio quella dell’helper in questione.
Ed è proprio qui che arriva la mia aggiunta, per integrare opzionalmente la callback “onNewComment” in caso serva.

Code block

function makeRepliable($onNewCommentCallback = null) {
        $projectName = Configure::read('Disqus.projectName');
 
        $return = '';
 
        if(!is_null($onNewCommentCallback)) {
            $return .= "
            <script type='text/javascript' src='http://ajax.googleapis.com/ajax/libs/jquery/1.4.4/jquery.min.js'></script>
            <script type='text/javascript'>
                function disqus_config() {this.callbacks.onNewComment = [function(comment) { $.post(\"$onNewCommentCallback\", comment);}];}
            </script>";
            }
 
        $return .= '<div id="disqus_thread"></div>';
        $return .= $this->Javascript->link("http://disqus.com/forums/{$projectName}/embed.js");
        return $return;
    }

Semplicemente, se il metodo viene chiamato con il parametro opzionale “$onNewCommentCallback” (url dell’azione che gestirà la risposta) viene stampato un pezzettino di javascript in più, che serve a dire a disqus quale url chiamare con la sua risposta dopo che è satto inserito con successo un commento.

Qui l’helper aggiornato:

Code block

<?php
// ./app/views/helpers/disqus.php
    /**
     * Disqus comment system integration Helper
     *
     * @author ToX - http://emanuele.itoscano.com - toss82 - at - gmail.com
     *
     * A little addition by Stefano Manfredini (optional anction for onNewComment callback)
     *
     * @help:
     *        In function makeRepliable, I set the projectName somewhere in my configuration files,
     *        remember to change this variable to something that suits your needs.
     *
     */
 
class DisqusHelper extends Helper {
    var $helpers = array('Html', 'Javascript');
 
    function repliesLinkCounter() {
        $projectName = Configure::read('Disqus.projectName');
        $createJS = "
            (function() {
                var links = document.getElementsByTagName('a');
                var query = '?';
                for(var i = 0; i < links.length; i++) {
                if(links.href.indexOf('#disqus_thread') >= 0) {
                    query += 'url' + i + '=' + encodeURIComponent(links.href) + '&amp;';
                }
                }
                document.write('<script charset=\"utf-8\" type=\"text/javascript\" src=\"http://disqus.com/forums/{$projectName}/get_num_replies.js' + query + '\"></' + 'script>');
            })();
        ";
        $return = $this->Javascript->codeBlock($createJS);
        return $return;
    }
 
    /**
     *
     * @param string $onNewCommentCallback, plain url to cake action receiving the "new comment" feedback from Disqus
     * @return the HTML to be rendered, with javascript call to Disqus service
     */
    function makeRepliable($onNewCommentCallback = null) {
        $projectName = Configure::read('Disqus.projectName');
 
        $return = '';
 
        // added by SM - optional cakephp action for the onNewComment callback.
        // e.g. "http://mysite.ext/comments/send_email_notice_to_author/1234
        // In this action, thans to the jquery ajax call using $.post, disqus response will be available in
        // $this->params['form'].
        // Disqus response is like this: array('id' => 12345, 'text' => 'comment body'),
        //  - you get $this->params['form']['id'] and $this->params['form']['text'] to work with;
        // so you can just send an email to the post author with the comment body, or use Disqus api like this:
        // http://docs.disqus.com/help/58/
        // to get the info you need about the comment, author, and so on
        // (and then process and save to your database as needed).
        // Be careful in your cakephp action - make some check (like, at least, $this->RequestHandler->isAjax())
        // to ensure it is not triggered bots (search engines or spambots..) who like to follow urls
        // written inside javascript bloks)
        //
        if(!is_null($onNewCommentCallback)) {
            $return .= "
            <script type='text/javascript'>
            if (typeof jQuery == 'undefined') {
                var script = document.createElement('script');
                script.type = 'text/javascript';
                script.src = 'http://ajax.googleapis.com/ajax/libs/jquery/1.4.4/jquery.min.js';
                document.getElementsByTagName('head')[0].appendChild(script);
            }
            </script>
 
            <script type='text/javascript'>
            jQuery.noConflict();
            function disqus_config() {this.callbacks.onNewComment = [function(comment) { jQuery.post(\"$onNewCommentCallback\", comment);}];}
            </script>";
        }
 
        $return .= '<div id="disqus_thread"></div>';
        $return .= $this->Javascript->link("http://disqus.com/forums/{$projectName}/embed.js");
        return $return;
    }
 
    function recentComments($num_items = 5, $hide_avatars = 0, $avatar_size = 32, $excerpt_lenght = 200) {
        $projectName = Configure::read('Disqus.projectName');
        $return =  "<div id='recentcomments' class='dsq-widget'>";
            $return .=  "<h2 class='dsq-widget-title'>". __('Recent Comments', true) ."</h2>";
            $return .= $this->Javascript->link("http://disqus.com/forums/{$projectName}/recent_comments_widget.js?num_items={$num_items}&hide_avatars={$hide_avatars}&avatar_size={$avatar_size}&excerpt_length={$excerpt_lenght}");
        $return .=  "</div>";
        return $return;
    }
}
?>

Come scritto nel commento nel codice, disqus (avendo chiamato con la azione ajax di jQuery $.post, fornisce alla nostra azione una risposta che -grazie a cakephp- ci troviamo automaticamente a popolare $this->params[‘form’]. Abbiamo così a disposizione l’id ed il testo del commento. A quel punto, nell’azione in cake, possiamo semplicemente ricavare l’email dell’autore del post e mandargli un avviso via email (con il testo del commento) oppure usare l’id per recuperare tutti gli altri dettagli usando l’API di disqus, e salvare una copia locale nel nostro db o fare quel che ci serve.

Attenzione: l’azione in questione (nel suddetto esempio, /comments/send_email_notice_to_author/$id) deve avere qualche controllo per assicurare che non sia una visita “diretta” -presubimilmente da uno spambot o altro spider che segue anche i link nel javascript) ma venga legittimamente da disqus.
Si può lavorare su $this->referer(), oppure un semplice if($this->RequestHandler->isAjax()) può essere sufficiente (altrimenti c’è il rischio che vangano inviati avvisi o inseriti commenti inesistenti).

Se usate o volete provare Disqus nella vostra applicazione cakephp, e volete quel gancio in più, potete aggiungere questa piccola modifica.
Intanto un doveroso ringraziamento ad Emanuele per aver creato l’helper!