Utiliser le moteur de rapports de SQL Server en PHP

La première étape sera bien sûr de télécharger le SDK. Après extraction de l'archive, seul le répertoire « bin » est à intégrer dans notre projet PHP, le reste étant de la documentation. Nous partons d'une application MVC avec l'arborescence standard de ZF (version 1.8 ou supérieur) telle que décrite dans la documentation officielle. Nous allons donc créer un répertoire library/SSRS et y copier le contenu du répertoire « bin » du SDK SSRS.

Il va falloir ensuite créer un accès pour notre application et pour cela SSRS utilise l'authentification Windows. Il faut donc ajouter un compte utilisateur Windows (ou utiliser le vôtre à des fins de test), et autoriser ce compte à accéder à la base de données. Pour cela, rendez-vous dans l'outil d'administration de SQL Server, allez dans les propriétés de sécurité / connexion, ajoutez l'utilisateur (avec le nom complet MACHINE\username ou DOMAIN\username). Sélectionnez ensuite la base de données qui servira aux rapports, ajoutez le compte utilisateur et donnez-lui les privilèges db_datareader et db_datawriter.

Reste maintenant à ajuster le degré de sécurité de SSRS. Pour cela, ouvrez le fichier rsreportserver.config localisé dans le répertoire de SSRS : C:\Program Files\Microsoft SQL Server \MSRS10.SQLEXPRESS\Reporting Services\ReportServer. Ce fichier est au format XML, et il faut ajouter l'élément <RSWindowsBasic/> au nœud <AuthenticationTypes> :

<Authentication>
    <AuthenticationTypes>
        <RSWindowsNegotiate/>
        <RSWindowsNTLM/>
        <RSWindowsKerberos />
        <RSWindowsBasic/>
    </AuthenticationTypes>
    <EnableAuthPersistence>true</EnableAuthPersistence>
</Authentication>

La directive RSWindowsNegotiate permet de basculer en Kerberos ou NTLM selon le protocole d'authentification supporté.

Pour pouvoir récupérer des rapports dans toute l'application, le plus simple est de créer un helper d'action qui pourra donc être appelé depuis n'importe quelle action de contrôleur.

La première chose à faire est de stocker les paramètres de connexion : URL du webservice, identifiant et mot de passe. Nous utilisons donc le fichier application/configs/application.ini dans lequel nous ajoutons les lignes suivantes :

ssrs.url      = "http://localhost:85/ReportsServer"
ssrs.username = "MACHINE\toto"
ssrs.password = "xxx"

Mettez donc une ligne comme celle-ci dans votre fichier C:\Windows\system32\drivers\etc\hosts (ou /etc/hosts sous Linux) :

192.168.1.5    reportserver

Si ce n'est pas déjà fait, rendez la configuration accessible aisément dans toute votre application en ajoutant la méthode suivante au bootstrap :

protected function _initConfig()
{
    $config = new Zend_Config($this->getOptions());
    Zend_Registry::set('config', $config);
    return $config;
}

La configuration sera ainsi accessible partout via un simple Zend_Registry::get('config').

Nous créons ensuite le fichier library/Application/Helper/Rapport.php. La classe ne comportera qu'une méthode direct() ce qui permet au helper d'être appelé directement dans les contrôleurs (pour plus de détails sur la manière de réaliser ses propres helpers d'action, voyez le manuel de Zend Framework). Voici le code source :

class Application_Helper_Rapport extends Zend_Controller_Action_Helper_Abstract
{
    /**
     * Récupère un rapport SSRS et l'affiche inline au format PDF
     * @param array $options paramètres d'affichage
     */
    public function direct($options)
    {
        $controller = $this->getActionController();
        $config = Zend_Registry::get('config');
        require_once(ROOT_PATH . '/library/ssrs/SSRSReport.php');
        try {
            // se connecte au webservice de SSRS
            $ssrs = new SSRSReport(new Credentials($config->ssrs->user, $config->ssrs->password), $config->ssrs->url);
            // charge le rapport demandé
            $report = $ssrs->LoadReport2($options['rapport']);
            // passe les éventuels paramètres
            if (array_key_exists('param', $options) and is_array($options['param']) and count($options['param']) > 0) {
                $params = array();
                foreach ($options['param'] as $key => $val) {
                    $param = new ParameterValue();
                    $param->Name = $key;
                    $param->Value = $val;
                    $params[] = $param;
                }
                $ssrs->SetExecutionParameters2($params);
            }
            // effectue le rendu en PDF
            $renderPdf = new RenderAsPDF();
            $rapport = $ssrs->Render2($renderPdf,
                PageCountModeEnum::$Actual,
                $Extension,
                $MimeType,
                $Encoding,
                $Warnings,
                $StreamIds);
            // prépare l'affichage en purgeant la vue et en mettant les bons headers HTTP
            $controller->getHelper('viewRenderer')->setNoRender();
            $controller->getHelper('layout')->disableLayout();
            $controller->getResponse()->clearBody();
            $controller->getResponse()
                       ->setHeader('Content-Disposition', 'inline; filename=document.pdf')
                       ->setHeader('Content-type', 'application/pdf')
                       ;
            // affiche le contenu du rapport sur le flux de sortie
            echo $rapport;
        } catch (SSRSReportException $serviceException) {
            throw new Exception($serviceException->GetErrorMessage());
        }
    }
}

La méthode Render2() prend un certain nombre de paramètres par référence, qui contiendront différentes informations sur la production du rapport au retour de l'appel de fonction. Dans le cas présent, je n'en ai pas besoin, mais cela peut servir par exemple à récupérer les images jointes pour un rapport affiché au format HTML.

Nous avons ici traité uniquement le cas des rapports PDF, mais les méthodes sont sensiblement équivalentes pour les autres formats, nous vous invitons à consulter la documentation fournie avec le SDK. Il faudra éventuellement adapter les headers http, et surtout le type mime (application/*) si vous utilisez un autre format que le PDF comme illustré dans l'exemple.

Il faut enfin veiller à ce que notre helper soit chargé dans le Bootstrap, pour cela créez une méthode _initHelpers, ou ajoutez une ligne à votre méthode existante :

protected function _initHelpers()
{
    Zend_Controller_Action_HelperBroker::addHelper(new Application_Helper_Rapport());
}

La récupération d'un rapport consiste en un seul appel de fonction dans une action de contrôleur, comme illustré ci-dessous :

public function printAction()
{
    $this->_helper->rapport(
        'rapport' => "/chemin/vers/le/rapport",
        'param' => array(
            'param1' => 'valeur1',
            'param2' => 'valeur2',
        ),
    );
}