-- UPDATE --

J'ai changé ma méthode pour récupérer directement une valeur dans ma liste de configuration. Je faisais un query qui me retournais une collection que je filtrais ensuite pour récupérer ma valeur. Alors qu'il suffisait simplement de le faire directement dans mon query

-- UPDATE --

Dans mes applications SharePoint, j’utilise très souvent une liste ou je stocke l’ensemble de mes éléments de configuration comme par exemple :

• Email sender pour mes workflows
• Sujet d’un email
• Corps d’un email
• Url d’un WebService
• Et bien d’autres choses encore...

Le gros avantage est que le webmaster du site peut facilement (à ses risques et périls tout de même ) mettre à jour les informations et ceci sans reset de l’application pool ou redémarrage de l’appli web sous IIS dans le cas par exemple de variables stockées dans le web.config.

La structure de ma liste est toute simple :

• Key (le champ title de base renommé);
• Value (la valeur à retourner) de type « Multiine of text » en mode Plain Text;
• Category, un champ de type « Choice » qui me permet de regrouper mes informations. Par exemple, sur une page, il peut m’arriver d’avoir à récupérer plusieurs valeurs de configuration. Ce regroupement, me permet de les récupérer via un seul CAML Query. Ceci m’évitant donc de faire un query pour chaque élément.

J’avais donc implémenté une classe qui me permettait de récupérer ces valeurs via un CAML query sur ma liste. Mais suite à un article posté par Philippe Sentenac sur les méthodes d’extensions, j’ai décidé de refaire cette classe en utilisant ces extensions et les nombreuses autres classes generics du framework .Net.

Pour commencer, j’ai étendu l’objet SPWeb pour accéder à notre Liste de configuration (dans mon cas, j’ai aussi besoin d’un paramètre « Category » pour me retourner l’ensemble des valeurs car je ne souhaite pas faire une requête pour chaque entrée). Cette méthode, me retourne une interface générique de type ILookup < TKey, TElement>. Cette interface, va me permettre ensuite de récupérer très facilement une entrée de ma configuration :

public static ILookup<String, String> ConfigurationList(this SPWeb spWeb, String Category)
{
    SPList spListConfiguration;
    ILookup<String, String> configurationEntries = null;
    // La liste n'est pas accessible aux end users.
    // On doit donc s'y connecter sur le compte admin pour y accéder
    // Optionnel, si vous avez décidé de mettre la liste en lecture pour tout vos utilisateurs
    SPSecurity.RunWithElevatedPrivileges(delegate()
    {
        using (SPSite mySite = new SPSite(spWeb.Site.ID))
        {
            using (SPWeb myWeb = mySite.OpenWeb(spWeb.ID))
            {

Je récupère ma liste « Configuration » grâce à la méthode d’extension TryGet de Philippe :

if (myWeb.Lists.TryGet("Configuration", out spListConfiguration))
{

J’exécute ensuite mon query pour récupérer mes éléments :

    SPQuery spQuery = new SPQuery();
    spQuery.Query = String.Format(<Where><Eq><FieldRef Name='Category' /><Value Type='Choice'>{0}</Value></Eq></Where>", Category);

Et je stock les résultats dans un document XML Linq (XDocument) :

XDocument xml = XDocument.Parse(spListConfiguration.GetItems(spQuery).Xml);

Je définie mon namespace pour me simplifier la lecture du code :

XNamespace z = "#RowsetSchema";

Je renvoie tout ce flux dans mon interface générique en lui spécifiant :

• Ma clé : key => key.Key;
• Ma valeur à retourner: element => element.Value;
• Mon comparateur d’égalité : EqualityComparer<String>.Default (ici comme je travaille sur des Strings je n’ai pas besoin d’en définir de particulier, mais si vous souhaitez le personnaliser, il vous suffit d’écrire une classe qui implémente IEqualityComparer<T>. Je donne un exemple à la fin de ce post pour implémenter une version qui ne prend pas en compte la casse de la clé) ;

configurationEntries = (from xmlItems in xml.Descendants(z + "row").ToArray()
    select new ConfigurationEntry { Key = (String)xmlItems.Attribute("ows_Title"), Value = (String)xmlItems.Attribute("ows_Value") })
    .ToLookup(key => key.Key, element => element.Value, EqualityComparer<String>.Default);
        });
    }
onfigurationEntries;
}

J’utile cette classe pour stocker ma clé ainsi que la valeur associée dans mon query Linq :

public class ConfigurationEntry
{
    public String Key;
    public String Value;
}

Ensuite, il ne me reste plus qu’a écrire la classe qui va me rechercher mon élément dans ma collection (on peut ici choisir de lui donner un objet SPWeb ou d’utiliser le context)

public sealed class Configuration
{
    private ILookup<String, String> configurationValues;
    
    public Configuration(SPWeb spWeb, String category)
    {
        if (spWeb == null)
            throw new ArgumentNullException("A SPWeb object cannot be null");
        if (String.IsNullOrEmpty(category))
            throw new ArgumentNullException("A category cannot be empty");

        configurationValues = spWeb.ConfigurationList(category);
    }

    public Configuration(String category)
    {
        if (SPContext.Current == null)
            throw new ArgumentNullException("SPContext cannot be null. Please ensure that you're running a SharePoint application");
        if (String.IsNullOrEmpty(category))
            throw new ArgumentNullException("A category cannot be empty");

        configurationValues = SPContext.Current.Web.ConfigurationList(category);
    }

    public String GetEntry(String key)
    {
        return Convert.ToString(configurationValues[key].FirstOrDefault());
    }
}

Notez l’utilisation du générique FirstOrDefault, qui nous permet ici de nous retourner un String.Empty s’il n’y a pas de valeur à retourner.

Ensuite, pour l’appel, c’est très simple. Instanciez un objet Configuration et utilisez la méthode GetEntry pour récupérer vos valeurs:

Configuration configValues = new Configuration(spWeb,"SSRS");
Console.WriteLine("SSRS URL:" + configValues.GetEntry("SSRSUrl"));
Console.WriteLine("SSRS Path:" + configValues.GetEntry("SSRSPath"));
Console.WriteLine("SSRS WebPartPage:" + configValues.GetEntry("SSRSWebPartPage"));

On peut aussi ajouter une variante à notre méthode d’extension ConfigurationList pour récupérer directement la valeur d’une clé dans notre liste :

public static String ConfigurationList(this SPWeb spWeb, String Category, String Key)
{
    SPList spListConfiguration;
    String returnValue = String.Empty;

    SPSecurity.RunWithElevatedPrivileges(delegate()
    {
        using (SPSite mySite = new SPSite(spWeb.Site.ID))
        {
            using (SPWeb myWeb = mySite.OpenWeb(spWeb.ID))
            {
                if (myWeb.Lists.TryGet("Configuration", out spListConfiguration))
                {
                    // Modification du 25 juin 2008
                    // J'ai pas fais attention en publiant mon post que cette méthode était stupide
                    // En effet, j'utilisais un query qui me retournais une collection que je filtrais ensuite pour retourner ma valeur
                    // Alors que je pouvais faire cela dans un seul CAML Query 
                    SPQuery spQuery = new SPQuery();
                    spQuery.Query = String.Format("<Where><And><Eq><FieldRef Name='Title' /><Value Type='Text'>{0}</Value></Eq><Eq><FieldRef Name='Category' /><Value Type='Choice'>{1}</Value></Eq></And></Where>", Key, Category);

                    SPListItemCollection items = spListConfiguration.GetItems(spQuery);
                    if (items != null
                        && items.Count > 0)
                        returnValue = Convert.ToString(items[0]["Value"]);
                    // SPQuery spQuery = new SPQuery();
                    // spQuery.Query = String.Format("<Where><Eq><FieldRef Name='Category' /><Value Type='Choice'>{0}</Value></Eq></Where>", Category);
                    // XDocument xml = XDocument.Parse(spListConfiguration.GetItems(spQuery).Xml);
                    // XNamespace z = "#RowsetSchema";
                    // configurationEntries = (from xmlItems in xml.Descendants(z + "row")
                    // select new ConfigurationEntry { Key = (String)xmlItems.Attribute("ows_Title"), Value = (String)xmlItems.Attribute("ows_Value") })
                    // .ToLookup(key => key.Key, element => element.Value, EqualityComparer<String>.Default);
                    // returnValue Convert.ToString(configurationEntries[Key].FirstOrDefault()); 
                }
            }
        }
    });

    return returnValue;
}

La récupération de votre valeur se faisant comme ceci:

Console.WriteLine("SSRS Url:" + spWeb.ConfigurationList("SSRS", "SSRSURL"));

Comme promis, voici ici un exemple de classe qui vous permet de comparer 2 Strings sans distinction de la casse :

public class StringNoCaseSensitive : IEqualityComparer<String>
{
    public Boolean Equals(String val1, String val2)
    {
        return (val1.ToLower() == val2.ToLower());
    }
    public int GetHashCode(string obj)
    {
        return obj.ToLower().GetHashCode();
    }
}

Dans l’appel du ILookup,remplacer EqualityComparer<String>.Default par new StringNoCaseSensitive() et le tour est joué...

Tags: Linq, SharePoint, WSS, MOSS

Dans le cadre d’un de mes projets de publication web sous MOSS, j’utilise très souvent le RAD editor pour SharePoint de Telerik. Il est vraiment très performant et d’une grande facilité d’utilisation.

Mais j’ai détecté un petit bug dans son utilisation lorsque vous souhaitez valider vos pages pour éviter les attaques par script injection (XSS) via l’attribut validateRequest=True.

<pages
    enableSessionState="true"
    enableViewState="true"
    enableViewStateMac="true"
    validateRequest="true"
    pageParserFilterType="Microsoft.SharePoint.ApplicationRuntime.SPPageParserFilter, Microsoft.SharePoint, Version=12.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c"
    asyncTimeout="7">

Il y a apparemment un bug sur certaines valeurs attribuées aux Id de ce control. Dans mon cas, j’avais ce control sur ma page :

<Telerik:RadHtmlField ID="Request" FieldName="Request" runat="server"/>

Ce qui provoquait une erreur de type:

Un rapide coup d’œil dans l’event viewer me donne un message d’erreur un peu plus explicite :

Ce message d’erreur est très explicite, il nous indique que le framework n’a pu trouver la methode validateInput et donc valider l’intégrité d’un control (du au fait du validateRequest à vrai). En effet, dès que je mettais mon attribut validateRequest à faux, ma page s’affichait correctement. Intrigué et surpris par le fait qu’un control ne puisse satisfaire à cette règle élémentaire du framework, j’ai tente de trouver sur le net (et en particulier le forum de telerik) quelques réponses. Mais absolument rien à ce sujet. N’étant pas le seul au monde à utiliser ce control et n’ayant rien trouvé dans mes investigations googleienne, je me suis dit que ca devait venir forcement d’une petite bricole sur ma page. J’ai donc vérifié l’appel à l’assembly dans mes attributs de pages (version, publickeytoken,…) ainsi que quelques propriétés du control (IsValid par exemple). Mais toujours rien… Et en relisant bien mon control, j’ai vu que la valeur de mon id était « Request ». Dans le doute et sans autres solutions, j’ai supprimé cet id en étant sur que ca n’avait aucun impact… et bien si. Détrompez-vous ! Je ne sais pas pour quelle raison, mais chez Telerik si votre id à pour valeur Request et que vous configuré votre application web pour éviter les XSS et bien ca plante… Ce n’est pas un gros problème en soit car il suffit juste de changer la valeur, mais c’est quand même surprenant…

Tags: SharePoint, Telerik, Rad controls, WSS, MOSS

MISE A JOUR DU 06 JUIN 2008
Pour contourner ce problème, il suffit en fait d'ajouter l'attribut id sur votre tag d'action:

<add path="configuration/system.web" id="{45C74BC1-DBA5-489f-A6E9-6932C25F1D97}">
        <xhtmlConformance mode="Strict" />
</add>

Ceci évitant la recréation multiple de vos actions. Grand merci à Gaetan Bouveret pour cet éclaircissement. Comme quoi la communauté SharePoint est plus forte que le SDK

-------------------------------
BILLET ORIGINAL

Je reprend ici un post de Gaetan Bouveret, au sujet de la mise à jour du fichier web.config sans ligne de code.

Je ne connaissais pas ce système de mise à jour via un flux xml. J'utilisais pour ce genre de déploiement le modèle objet et son SPWebConfigModification.

Intéressé par son post, j'ai donc essayé de le mettre en place sur un de mes projets.

J'ai donc ajouté dans un fichier xml (déployé par ma feature dans le répertoire config du 12) cette ligne:

<add path="configuration/system.web">
        <xhtmlConformance mode="Strict" />
</add> 

Pour déployer ce fichier dans votre web.config, il vous faut exécuter la commande :

stsadm -o copyappbincontent

Lors de la toute première commande tout marche parfaitement bien, mon noeud est bien ajouté là ou je le voulais.

<system.web>
        ....
        <xhtmlConformance mode="Strict" />
</system.web>

Le problème de cette commande add est qu'elle ne vérifie pas la présence du noeud à ajouter. Ce qui fais que si vous exécutez une nouvelle fois la commande stsadm -o copyappbincontent, ce noeud est ajouté une deuxième fois. Et dans le cas précis de cet exemple, cela fais planter mon application web car le noeud xhtmlConformance doit être unique.

Pour remédier à cela, j'ai simplement ajouté une commande remove juste avant la commande add:

<remove path="configuration/system.web/xhtmlConformance" />

Pour info, la valeur de path est une fonction xpath, vous pouvez donc allez chercher l'élément à supprimer même si les noeuds fils ont le même nom.

<remove path="configuration/system.web/httpModules/add[@name='Session']" />
<add path="configuration/system.web/httpModules">
        <add name="Session" type="System.Web.SessionState.SessionStateModule"/>
</add>

ps: Attention pour les fermes, le SDK stipule bien que cette commande doit être exécutée sur chaque serveur de la ferme.

Tags: SharePoint, Admin et Configuration, WSS, MOSS