El blog de Lluis Franco : Serie

SharePoint 2007 + Outlook 2007: Guardar correos de forma masiva (VII)

lfranco — Fri, 20 Mar 2009 08:07:00 GMT

Entradas anteriores de la serie:

SharePoint 2007 + Outlook 2007: Guardar correos de forma masiva (I)

SharePoint 2007 + Outlook 2007: Guardar correos de forma masiva (II)

SharePoint 2007 + Outlook 2007: Guardar correos de forma masiva (III)

SharePoint 2007 + Outlook 2007: Guardar correos de forma masiva (IV)

SharePoint 2007 + Outlook 2007: Guardar correos de forma masiva (V)

SharePoint 2007 + Outlook 2007: Guardar correos de forma masiva (VI)

Han pasado unos días desde que publiqué la última entrada, y es que voy absolutamente desbordado de curro.

Pero como lo prometido es deuda, vamos a proseguir con el tema, ya quedan un par de temas por ver antes de concluir la serie:

Cómo ejecutar distintos threads y mostrar el progreso (Callbacks).

Cómo distribuir nuestro complemento, creando un archivo MSI (Windows Installer packages).

Además, os dije que en el último post publicaría el código fuente del proyecto… y varios de vosotros ya lo habéis reclamado con insistencia :-P

De modo que vamos a hacerlo al revés: Hoy publico el código fuente del proyecto, y mañana (espero) continuaré el resto de la serie. De este modo al menos ya tendreis el código para jugar con él, y poder machacarme a preguntas…

El proyecto incluye el código de ejemplo del Add-In y el proyecto de instalación, y lo podéis descargar desde este enlace de Skydrive:

http://cid-f3a970280830b5fe.skydrive.live.com/self.aspx/MSDN%20Samples/OutlookToMOSS/OutlookToMOSS.zip

Saludos desde Andorra,

** crossposting desde el blog de Lluís Franco en geeks.ms **

SharePoint 2007 + Outlook 2007: Guardar correos de forma masiva (VI)

lfranco — Thu, 05 Mar 2009 14:57:00 GMT

Entradas anteriores de la serie:

SharePoint 2007 + Outlook 2007: Guardar correos de forma masiva (I)

SharePoint 2007 + Outlook 2007: Guardar correos de forma masiva (II)

SharePoint 2007 + Outlook 2007: Guardar correos de forma masiva (III)

SharePoint 2007 + Outlook 2007: Guardar correos de forma masiva (IV)

SharePoint 2007 + Outlook 2007: Guardar correos de forma masiva (V)

Ahora que parece que Bender está un poco más sobrio que de costumbre, prosigamos con la serie... que sabéis como se pone cuando no bebe.

Menú del día:

De primero: Cómo guardar un fichero en una biblioteca de documentos de SharePoint manteniendo el control de versiones.

De segundo: Cómo modificar los metadatos del fichero una vez subido a la biblioteca (From, To, Subject).

Postre: Pastel especial de la casa.

Pan, Vino y Café incluidos

El primero:

Es curioso, pero SharePoint en la versión actual no implementa “de serie” ningún mecanismo para subir documentos a una librería de documentos. Ahora que nos hemos quedado con la boca abierta, vamos a explicar algunos mecanismos para hacerlo por nuestra cuenta.

El bueno de mi tío Rodrigo hace un tiempo que publicó un post al respecto, en el cual se mostraba cómo subir ficheros a un SharePoint. Pero como él mismo decía, la pega estaba en que usando esta técnica no se disponía de historial de versiones. La alternativa era crearse un WebService propio, tal y como se explica en este artículo, aunque es una solución que no siempre se puede usar. Hoy veremos una tercera alternativa que permite hacerlo sin tener que recurrir a la creación de un WebService. La he probado en un servidor MOSS y en un par de WSS, uno local y el otro hospedado en un hosting en USA. Y en ambos funciona perfectamente, aunque en el segundo los tiempos se demoran un poco...

Describamos los elementos que necesitamos a continuación:

Para empezar vamos a crear una clase FileInfo para encapsular lo relativo al fichero que vamos a subir (nombre, propiedades, URI, y por supuesto los bytes):

public class FileInfo

    public string m_URL;

    public byte[] m_bytes;

    public Dictionary<string, object> m_properties;

    public ListInfo m_listInfo;

    public bool m_ensureFolders = true;

    private Uri m_uri;

    public bool HasProperties

get

            return m_properties != null && m_properties.Count > 0;

    public string RelativeFilePath

get

            return m_URL.Substring(m_URL.IndexOf(m_listInfo.m_rootFolder) + 1);

    public Uri URI

get

            if (m_uri == null) m_uri = new Uri(m_URL);

            return m_uri;

    public string LookupName

get

            if (m_listInfo != null && !string.IsNullOrEmpty(m_listInfo.m_listName))

                return m_listInfo.m_listName;

            return URI.LocalPath;

    public FileInfo(string url, byte[] bytes, Dictionary<string, object> properties)

        m_URL = url.Replace("%20", " ");

        m_bytes = bytes;

        m_properties = properties;

A continuación un método Upload con dos sobrecargas, que será el que invocaremos desde la ventana encargada de mostrar el progreso de la operación. Éste será el encargado de recibir la URL de destino, los bytes del fichero a subir (previamente debemos guardar el elemento de correo en un fichero o stream), las propiedades, y el elemento de correo para poder actualizar las columnas de metadatos. Este método Upload será el encargado de a su vez llamar al método TryToUpload, que realmente será el encargado de subir el fichero:

public bool Upload(string destinationUrl, byte[] bytes, Dictionary<string, object> properties, Outlook.MailItem item)

    return Upload(new FileInfo(destinationUrl, bytes, properties), item);

public bool Upload(FileInfo fileInfo, Outlook.MailItem item)

    if (fileInfo.HasProperties)

        fileInfo.m_listInfo = m_lists.Find(fileInfo);

    bool result = TryToUpload(fileInfo, item);

    if (!result && fileInfo.m_ensureFolders)

        string root = fileInfo.URI.AbsoluteUri.Replace(fileInfo.URI.AbsolutePath, "");

        for (int i = 0; i < fileInfo.URI.Segments.Length - 1; i++)

            root += fileInfo.URI.Segments;

            if (i > 1) CreateFolder(root);

        result = TryToUpload(fileInfo, item);

    return result;

Y para terminar, el método TryToUpload que se encarga de crear el objeto WebRequest necesario, crear el stream y actualizar los valores de las propiedades de los campos, para invocar finalmente el método UpdateListItems del servicio Web:

private bool TryToUpload(FileInfo fileInfo, Outlook.MailItem item)

try

        WebRequest request = WebRequest.Create(fileInfo.m_URL);

        request.Credentials = sharePointLists.Credentials;

        request.Method = "PUT";

        byte[] buffer = new byte[1024];

        using (Stream stream = request.GetRequestStream())

        using (MemoryStream ms = new MemoryStream(fileInfo.m_bytes))

            for (int i = ms.Read(buffer, 0, buffer.Length); i > 0; i = ms.Read(buffer, 0, buffer.Length))

                stream.Write(buffer, 0, i);

        WebResponse response = request.GetResponse();

        response.Close();

        if (fileInfo.HasProperties)

            StringBuilder sb = new StringBuilder();

            sb.Append("<Method ID='1' Cmd='Update'><Field Name='ID'/>");

            sb.AppendFormat("<Field Name='FileRef'>{0}</Field>", fileInfo.m_URL);

            foreach (KeyValuePair<string, object> property in fileInfo.m_properties)

                sb.AppendFormat("<Field Name='{0}'>{1}</Field>", property.Key, property.Value);

            updateMetadataColumns(fileInfo, item, sb);

            sb.Append("</Method>");

            System.Xml.XmlElement updates = (new System.Xml.XmlDocument()).CreateElement("Batch");

            updates.SetAttribute("OnError", "Continue");

            updates.SetAttribute("ListVersion", fileInfo.m_listInfo.m_version);

            updates.SetAttribute("PreCalc", "TRUE");

            updates.InnerXml = sb.ToString();

            sharePointLists.Url = fileInfo.m_listInfo.m_webUrl + "/_vti_bin/Lists.asmx";

            XmlNode updatesResponse = sharePointLists.UpdateListItems(fileInfo.m_listInfo.m_listName, updates);

            if (updatesResponse.FirstChild.FirstChild.InnerText != "0x00000000")

                throw new Exception("Could not update properties.");

        return true;

    catch (WebException ex)

        throw ex;

Lo juntamos todo, compilamos, probamos a subir algunos mensajes varias veces y voilá! Si observamos el control de versiones veremos lo siguiente:

El segundo:

Si hemos observado con atención el código del método TryToUpload seguramente hemos visto una llamada a un método updateMetaDataColumns, al cual se le pasa el StringBuilder que estamos construyendo, para que nos agregue los valores de los metadatos (cuya sintaxis que expresarse en XML según la ayuda del método UpdateListItems). El código es muy sencillo y básicamente lo que hace es comprobar si en la lista destino existen las columnas de metadatos, y en caso afirmativo modificar su valor:

private void updateMetadataColumns(FileInfo fileInfo, Outlook.MailItem item, StringBuilder sb)

    var cols = from c in SharePointExtensions.getListColumns(

               sharePointLists, fileInfo.m_listInfo.m_listName)

               where c.Hidden == false && c.Sealed == false && c.ReadOnly == false

               select c;

    Dictionary<string, SPColumnInfo> columns = cols.ToDictionary(c => c.Name);

    if (columns.ContainsKey(Properties.Settings.Default.COL_SUBJECT) && item != null)

        sb.AppendFormat("<Field Name='{0}'>{1}</Field>",

            Properties.Settings.Default.COL_SUBJECT, item.Subject);

    if (columns.ContainsKey(Properties.Settings.Default.COL_FROM) && item != null)

        sb.AppendFormat("<Field Name='{0}'>{1}</Field>",

            Properties.Settings.Default.COL_FROM, item.SenderName);

    if (columns.ContainsKey(Properties.Settings.Default.COL_TO) && item != null)

        sb.AppendFormat("<Field Name='{0}'>{1}</Field>",

            Properties.Settings.Default.COL_TO, item.To);

    if (columns.ContainsKey(Properties.Settings.Default.COL_CC) && item != null)

        sb.AppendFormat("<Field Name='{0}'>{1}</Field>",

            Properties.Settings.Default.COL_CC, item.CC);

    if (columns.ContainsKey(Properties.Settings.Default.COL_BCC) && item != null)

        sb.AppendFormat("<Field Name='{0}'>{1}</Field>",

            Properties.Settings.Default.COL_BCC, item.BCC);

    if (columns.ContainsKey(Properties.Settings.Default.COL_SIZE) && item != null)

        sb.AppendFormat("<Field Name='{0}'>{1}</Field>",

            Properties.Settings.Default.COL_SIZE, item.Size);

    if (columns.ContainsKey(Properties.Settings.Default.COL_SENT) && item != null)

        string dt = item.SentOn.ToString("yyyy-MM-ddTHH:mm:ssZ");

        sb.AppendFormat("<Field Name='{0}'>{1}</Field>",

            Properties.Settings.Default.COL_SENT, dt);

    if (columns.ContainsKey(Properties.Settings.Default.COL_IMPORTANCE) && item != null)

        string im = string.Empty;

        switch (item.Importance)

            case Microsoft.Office.Interop.Outlook.OlImportance.olImportanceHigh:

                im = Properties.Settings.Default.COL_IMPORTANCE_HIGH;

                break;

            case Microsoft.Office.Interop.Outlook.OlImportance.olImportanceLow:

                im = Properties.Settings.Default.COL_IMPORTANCE_LOW;

                break;

            case Microsoft.Office.Interop.Outlook.OlImportance.olImportanceNormal:

            default:

                im = Properties.Settings.Default.COL_IMPORTANCE_MEDIUM;

                break;

        sb.AppendFormat("<Field Name='{0}'>{1}</Field>",

            Properties.Settings.Default.COL_IMPORTANCE, im);

El postre:

Ingredientes :
125 gr. de chocolate
60 gr. de mantequilla
125 gr. de azúcar
3 huevos
60 gr. de maizena

Receta :
Fundir el chocolate con la mantequilla a fuego lento.
Separar las yemas y las claras.
Mezclar el azúcar con las yemas de los huevos.
Añadir la maicena y después el chocolate fundido.
Montar las claras de huevo a punto de nieve y añadirlas lentamente a la mezcla.
Verter la mezcla en un molde donde se ha extendido la mantequilla previamente.
Hornearlo entre 20 ó 25 minutos a 180º.

Para terminar:

En los próximos artículos veremos cómo realizar este proceso de subida de ficheros de forma asíncrona usando callbacks, para poder continuar trabajando con Outlook y mostrar el progreso en una barra. También para cerrar la serie, veremos los pasos que hay que hacer para construir el proyecto de instalación de nuestro Add-In, y así poder distribuirlo.

Nos vemos!

** crossposting desde el blog de Lluís Franco en geeks.ms **

SharePoint 2007 + Outlook 2007: Guardar correos de forma masiva (V)

lfranco — Tue, 03 Mar 2009 17:28:00 GMT

Entradas anteriores de la serie:

SharePoint 2007 + Outlook 2007: Guardar correos de forma masiva (I)

SharePoint 2007 + Outlook 2007: Guardar correos de forma masiva (II)

SharePoint 2007 + Outlook 2007: Guardar correos de forma masiva (III)

SharePoint 2007 + Outlook 2007: Guardar correos de forma masiva (IV)

Después de algunos días sin poder seguir con la serie porque han detenido a Bender hay que sacar adelante otros proyectos, volvemos a la carga con lo que promete ser la serie de artículos más larga que he publicado hasta ahora en este blog.

Antes de nada vamos a ponernos al día:

Que pretendemos?

Crear un add-in de Outlook que permita guardar nuestros correos en una librería de documentos de SharePoint (tanto MOSS como WSS).

Que necesitamos?

Cómo crear un complemento para Office (VSTO). visto
Cómo registrar acciones en los menús de la aplicación host (Outlook). visto
Cómo conectar con un servidor MOSS/WSS con diferentes credenciales de usuario (System.Net.NetworkCredential) visto
Cómo acceder a los sitios y listas de un site de MOSS/WSS (servicios Web de SharePoint). visto
Cómo interpretar la información XML devuelta por los servicios (LINQ to XML). visto
Cómo extender el modelo de objetos de SharePoint para acceder los valores devueltos por los servicios Web.
Cómo crear las columnas necesarias en una lista para guardar los metadatos del elementos de correo (From, To, Subject).
Cómo guardar un fichero en una biblioteca de documentos de SharePoint con control de versiones (DocLibHelper).
Cómo ejecutar distintos threads y mostrar el progreso (Callbacks).
Cómo distribuir nuestro complemento, creando un archivo MSI (Windows Installer packages).

Que vamos a ver hoy?

En este post vamos a centrarnos en cómo obtener datos de los servicios Web de SharePoint. En nuestro caso necesitamos obtener las colecciones de sitios, las librerías de cada uno de los sitios, y las carpetas de cada librería para mostrarlos en una ventana que permita al usuario seleccionar la ubicación en la que desea guardar los elementos de coreo:

Del mismo modo, vamos a necesitar obtener las columnas de la librería seleccionada, para comprobar si ya existen las columnas para almacenar los metadatos de los elementos de correo, y en caso contrario proceder a crearlas (esto va a ir muy bien para posteriormente poder clasificar los elementos).

Extendiendo el modelo de objetos de SharePoint

En el post anterior ya vimos que habíamos declarado algunas clases de apoyo (como la clase ‘SPSiteInfo’) para que nuestros métodos (como el método ‘getSiteSubSites’ que también vimos en el anterior post) pudiesen devolver colecciones genéricas de éestos tipos de datos, lo cual es mucho más manejable que pelearnos con el XML que devuelven los servicios Web de SharePoint.

Los métodos que vamos a crear son:

getSiteSubSites: Devuelve una lista genérica de objetos ‘SPSiteInfo’, a partir de un servicio Web websProxy.Webs
getSiteLists: Devuelve una lista genérica de objetos ‘SPListInfo’, a partir de un servicio Web listsProxy.Lists
getListFolders: Devuelve una lista genérica de objetos ‘SPFolderInfo’, a partir de un servicio Web listsProxy.Lists
getListColumns: Devuelve una lista genérica de objetos ‘SPFolderInfo’, a partir de un servicio Web listsProxy.Lists y de un listID (GUID)
createMetadataColumns: Crea las columnas de metadatos definidas en los settings del add-in en una lista, a partir de un servicio Web listsProxy.Lists y de un listID (GUID).

Las clases de apoyo son:

public class SPSiteInfo

    public string Title { get; set; }

    public string URL { get; set; }

    public SPSiteInfo()

//

    public SPSiteInfo(string title, string url)

        Title = title;

        URL = url;

public class SPListInfo

    public Guid ID { get; set; }

    public string Title { get; set; }

    public string URL { get; set; }

    public SPListInfo()

//

    public SPListInfo(Guid id, string title, string url)

        ID = id;

        Title = title;

        URL = url;

public class SPFolderInfo

    public string Title { get; set; }

    public string URL { get; set; }

    public SPFolderInfo()

//

    public SPFolderInfo(string title, string url)

        Title = title;

        URL = url;

public class SPColumnInfo

    public string ID { get; set; }

    public string Type { get; set; }

    public string DisplayName { get; set; }

    public string Name { get; set; }

    public bool Hidden { get; set; }

    public bool Sealed { get; set; }

    public bool ReadOnly { get; set; }

    public SPColumnInfo()

//

    public SPColumnInfo(string id, string type,

        string displayName, string name, bool hidden,

        bool issealed, bool isreadonly)

        ID = id;

        Type = type;

        DisplayName = displayName;

        Name = name;

        Hidden = hidden;

        Sealed = issealed;

        ReadOnly = isreadonly;

Y el código de los métodos será el siguiente:

public class SharePointExtensions

    public static List<SPSiteInfo> getSiteSubSites(websProxy.Webs sharePointWebs)

try

            XmlNode websResult = sharePointWebs.GetWebCollection();

            XDocument results = XDocument.Parse(websResult.OuterXml);

            XName name = XName.Get("Web", "http://schemas.microsoft.com/sharepoint/soap/");

            var webs = from item in results.Descendants(name)

                       select new SPSiteInfo

                           item.Attribute("Title").Value,

                           item.Attribute("Url").Value

);

            return webs.ToList();

        catch (Exception ex)

            throw ex;

    public static List<SPListInfo> getSiteLists(listsProxy.Lists sharePointLists)

try

            XmlNode listsResult = sharePointLists.GetListCollection();

            XDocument results = XDocument.Parse(listsResult.OuterXml);

            XName name = XName.Get("List", "http://schemas.microsoft.com/sharepoint/soap/");

            var lists = from item in results.Descendants(name)

                        where item.Attribute("ServerTemplate").Value.ToString() ==

                            Properties.Settings.Default.SERVER_TEMPLATE

                        select new SPListInfo

                            new Guid(item.Attribute("ID").Value),

                            item.Attribute("Title").Value,

                            item.Attribute("DefaultViewUrl").Value

);

            return lists.ToList();

        catch (Exception ex)

            throw ex;

    public static List<SPFolderInfo> getListFolders(listsProxy.Lists sharePointLists,

        string listName, string listText, string folderURL)

try

            XmlDocument xmlDoc = new System.Xml.XmlDocument();

            XmlNode ndQuery = xmlDoc.CreateNode(XmlNodeType.Element, "Query", "");

            XmlNode ndViewFields =

              xmlDoc.CreateNode(XmlNodeType.Element, "ViewFields", "");

            XmlNode ndQueryOptions = null;

            if (listName != folderURL)

                ndQueryOptions = xmlDoc.CreateNode(

                    XmlNodeType.Element, "QueryOptions", "");

                ndQueryOptions.InnerXml = string.Format(

                    "<Folder>{0}/{1}</Folder>", listName, folderURL);

            XName name = XName.Get("data", "urn:schemas-microsoft-com:rowset");

            XmlNode ndListItems =

                    sharePointLists.GetListItems(listText, null, ndQuery,

                    ndViewFields, null, ndQueryOptions, null);

            XDocument results = XDocument.Parse(ndListItems.OuterXml);

            var folders = from item in results.Descendants(name).Elements()

                          where item.Attribute("ows_ContentType").Value == "Carpeta"

                          select new SPFolderInfo

                             item.Attribute("ows_BaseName").Value,

                             item.Attribute("ows_ServerUrl").Value

);

            return folders.ToList();

        catch (Exception ex)

            throw ex;

    public static List<SPColumnInfo> getListColumns(listsProxy.Lists sharePointLists, string siteID)

try

            List<SPColumnInfo> columns =new List<SPColumnInfo>();

            XmlNode listsResult = sharePointLists.GetList(siteID);

            XDocument results = XDocument.Parse(listsResult.OuterXml);

            XName name = XName.Get("Field", "http://schemas.microsoft.com/sharepoint/soap/");

            var lists = from item in results.Descendants(name)

                        select item;

            foreach (var item in lists.ToList())

                XAttribute aID = item.Attribute("ID");

                XAttribute aType = item.Attribute("Type");

                XAttribute aDisplayName = item.Attribute("DisplayName");

                XAttribute aName = item.Attribute("Name");

                XAttribute aHidden = item.Attribute("Hidden");

                XAttribute aSealed = item.Attribute("Sealed");

                XAttribute aReadOnly = item.Attribute("ReadOnly");

                if (aID != null && aType != null && aDisplayName != null &&

                    aName != null)

                    bool ishidden = false;

                    bool issealed = false;

                    bool isreadonly = false;

                    if (aHidden != null && aHidden.Value.ToString() == "TRUE") ishidden = true;

                    if (aSealed != null && aSealed.Value.ToString() == "TRUE") issealed = true;

                    if (aReadOnly != null && aReadOnly.Value.ToString() == "TRUE") isreadonly = true;

                    columns.Add(new SPColumnInfo(

                        aID.Value.ToString(),

                        aType.Value.ToString(),

                        aDisplayName.Value.ToString(),

                        aName.Value.ToString(),

                        ishidden, issealed, isreadonly));

            return columns;

        catch (Exception ex)

            throw ex;

    public static void createMetadataColumns(listsProxy.Lists sharePointLists, string listID)

        int createColumnsCount = 0;

        if (!Properties.Settings.Default.OPTION_CREATE_METADATA_COLUMNS) return;

        var cols = from c in SharePointExtensions.getListColumns(

                   sharePointLists, listID)

                   where c.Hidden == false && c.Sealed == false && c.ReadOnly == false

                   select c;

        Dictionary<string, SPColumnInfo> columns = cols.ToDictionary(c => c.Name);

        string newFieldsList = "";

        if (!columns.ContainsKey(Properties.Settings.Default.COL_SUBJECT))

            string subjectfield =

                @"<Method ID='1'><Field Type='Text' DisplayName='{0}' MaxLength='255'/></Method>";

            newFieldsList += string.Format(subjectfield, Properties.Settings.Default.COL_SUBJECT);

            createColumnsCount++;

        if (!columns.ContainsKey(Properties.Settings.Default.COL_TO))

            string subjectfield =

                @"<Method ID='2'><Field Type='Text' DisplayName='{0}' MaxLength='255'/></Method>";

            newFieldsList += string.Format(subjectfield, Properties.Settings.Default.COL_TO);

            createColumnsCount++;

        if (!columns.ContainsKey(Properties.Settings.Default.COL_CC))

            string subjectfield =

                @"<Method ID='3'><Field Type='Text' DisplayName='{0}' MaxLength='255'/></Method>";

            newFieldsList += string.Format(subjectfield, Properties.Settings.Default.COL_CC);

            createColumnsCount++;

        if (!columns.ContainsKey(Properties.Settings.Default.COL_BCC))

            string subjectfield =

                @"<Method ID='4'><Field Type='Text' DisplayName='{0}' MaxLength='255'/></Method>";

            newFieldsList += string.Format(subjectfield, Properties.Settings.Default.COL_BCC);

            createColumnsCount++;

        if (!columns.ContainsKey(Properties.Settings.Default.COL_FROM))

            string subjectfield =

                @"<Method ID='5'><Field Type='Text' DisplayName='{0}' MaxLength='255'/></Method>";

            newFieldsList += string.Format(subjectfield, Properties.Settings.Default.COL_FROM);

            createColumnsCount++;

        if (!columns.ContainsKey(Properties.Settings.Default.COL_SENT))

            string subjectfield =

                @"<Method ID='6'><Field Type='DateTime' DateOnly='FALSE' DisplayName='{0}'/></Method>";

            newFieldsList += string.Format(subjectfield, Properties.Settings.Default.COL_SENT);

            createColumnsCount++;

        if (!columns.ContainsKey(Properties.Settings.Default.COL_SIZE))

            string subjectfield =

                @"<Method ID='7'><Field Type='Number' DisplayName='{0}'/></Method>";

            newFieldsList += string.Format(subjectfield, Properties.Settings.Default.COL_SIZE);

            createColumnsCount++;

        if (!columns.ContainsKey(Properties.Settings.Default.COL_IMPORTANCE))

            string subjectfield =

                @"<Method ID='8'><Field Type='Choice' DisplayName='{0}'>;

                  <Default>{1}</Default>

                  <CHOICES>

                    <CHOICE>{2}</CHOICE>

                    <CHOICE>{3}</CHOICE>

                    <CHOICE>{4}</CHOICE>

                  </CHOICES>

                </Field></Method>"

            newFieldsList += string.Format(subjectfield,

                Properties.Settings.Default.COL_IMPORTANCE,

                Properties.Settings.Default.COL_IMPORTANCE_MEDIUM,

                Properties.Settings.Default.COL_IMPORTANCE_HIGH,

                Properties.Settings.Default.COL_IMPORTANCE_MEDIUM,

                Properties.Settings.Default.COL_IMPORTANCE_LOW);

            createColumnsCount++;

        if (createColumnsCount > 0)

            XmlNode ndList = sharePointLists.GetList(listID);

            XmlNode ndVersion = ndList.Attributes["Version"];

            XmlDocument xmlDoc = new System.Xml.XmlDocument();

            XmlNode ndNewFields = xmlDoc.CreateNode(XmlNodeType.Element, "Fields", "");

            ndNewFields.InnerXml = newFieldsList;

try

                XmlNode ndReturn =

                   sharePointLists.UpdateList(listID,

                   null, ndNewFields, null, null,

                   ndVersion.Value);

            catch (Exception ex)

                throw ex;

Y con esto ya estamos en disposición de mostrar un cuadro de diálogo al usuario, para que seleccione la ubicación en el servidor de SharePoint dónde quiere guardar los elementos de correo.

En el próximo post veremos cómo guardar los elementos de corro en la ubicación seleccionada, creando las columnas de metadatos (si así lo hemos definido), y actualizando el valor de éstas columnas para guardar los valores de los campos de correo (Asunto, De, Para, Fecha, Tamaño, etc.).

Os recuerdo que al terminar la serie publicaré la solución con el código completo, por si a alguien le sirve.

Espero no demorarme tanto en escribir el próximo post!

Nos vemos, un saludo desde Andorra!

** crossposting desde el blog de Lluís Franco en geeks.ms **

SharePoint 2007 + Outlook 2007: Guardar correos de forma masiva (IV)

lfranco — Tue, 10 Feb 2009 15:31:00 GMT

Entradas anteriores de la serie:

SharePoint 2007 + Outlook 2007: Guardar correos de forma masiva (I)

SharePoint 2007 + Outlook 2007: Guardar correos de forma masiva (II)

SharePoint 2007 + Outlook 2007: Guardar correos de forma masiva (III)

He estado un par de días sin poder continuar con la serie, pero es que el trabajo aprieta y no siempre nos podemos dedicar a lo que más nos gusta...

Recapitulando: Cosas que necesitamos para nuestro add-in:

Cómo crear un complemento para Office (VSTO). visto en el post anterior.
Cómo registrar acciones en los menús de la aplicación host (Outlook). Lo veremos ahora.
Cómo conectar con un servidor MOSS/WSS con diferentes credenciales de usuario (System.Net.NetworkCredential) Esto también lo veremos ahora.
Cómo acceder a los sitios y listas de un site de MOSS/WSS (servicios Web de SharePoint). visto en el post anterior.
Cómo interpretar la información XML devuelta por los servicios (LINQ to XML). Y esto también lo veremos ahora.
El resto de cosas las veremos en los próximos días...

Hoy nos centraremos en mostrar cómo agregar opciones a los menús de Outlook (para lanzar nuestras acciones personalizadas), ver cómo conectar con un sitio de SharePoint con las credenciales predeterminadas, o bien proporcionando un usuario y password. Y además veremos cómo interpretar el resultado devuelto por los servicios Web, ya que el usar LINQ to XML va a facilitarnos en mucho la tarea de lidiar con XML puro y duro.

Demos un vistazo al futuro, a lo que va a ser este Add-In (solo Bender puede viajar al futuro):

1 - Una vez registradas nuestras propias acciones en el menú de Outlook, éstas permitirán guardar los elementos selecionados:

2 – Aparecerá una ventana en la que podremos se leccionar la biblioteca de documentos y la carpeta destino:

3 – Una vez seleccionada la carpeta, mostraremos una ventana de progreso en un hilo separado para que el usuario pueda seguir interactuando con Outlook:

4 – Una vez terminado, si vamos a la biblioteca de documentos aparecerán los documentos (y más adelante también los metadatos):

Vayamos por partes:

Registrar acciones en un menú de Outlook:

Registrar el menú es sencillo, sólo debemos modificar el código del evento ‘ItemContextMenuDisplay’ (como ya vimos en el post anterior), y llamar a un método ‘RegisterMenu’ que se encarga de agregar nuestras acciones al menú contextual de Outlook.

void Application_ItemContextMenuDisplay(

    Microsoft.Office.Core.CommandBar CommandBar,

    Microsoft.Office.Interop.Outlook.Selection Selection)

    RegisterMenu(CommandBar, false);

void RegisterMenu(Microsoft.Office.Core.CommandBar CommandBar, bool IsFolder)

    Office.CommandBarPopup cmdSaveToMOSS =

        (Office.CommandBarPopup)CommandBar.FindControl(

        missing, missing, "STSMOSS", missing, missing);

    if (cmdSaveToMOSS == null)

        cmdSaveToMOSS = (Office.CommandBarPopup)CommandBar.Controls.Add(

                Office.MsoControlType.msoControlPopup, missing,

                missing, missing, false);

        if (cmdSaveToMOSS != null)

            cmdSaveToMOSS.Caption = Properties.Resources.CONTEXT_MENU_CAPTION;

            cmdSaveToMOSS.Tag = "STMOSS";

            cmdSaveToMOSS.BeginGroup = true;

            Office.CommandBarButton btnSaveToMOSS =

                (Office.CommandBarButton)cmdSaveToMOSS.Controls.Add(

                Office.MsoControlType.msoControlButton, missing, missing, missing, missing);

            btnSaveToMOSS.Caption = Properties.Resources.CONTEXT_MENU_SENDBUTTON;

            btnSaveToMOSS.FaceId = 65;

            btnSaveToMOSS.Tag = IsFolder.ToString();

            btnSaveToMOSS.Style = MsoButtonStyle.msoButtonIconAndCaption;

            btnSaveToMOSS.Picture = getImage();

            btnSaveToMOSS.Click += new Microsoft.Office.Core.

                _CommandBarButtonEvents_ClickEventHandler(saveToMOSS_Click);

            Office.CommandBarButton btnConfigurationMOSS =

                (Office.CommandBarButton)cmdSaveToMOSS.Controls.Add(

                Office.MsoControlType.msoControlButton, missing, missing, missing, missing);

            btnConfigurationMOSS.Caption = Properties.Resources.CONTEXT_MENU_CONFIGURATIONBUTTON;

            btnConfigurationMOSS.BeginGroup = true;

            btnConfigurationMOSS.Style = MsoButtonStyle.msoButtonIconAndCaption;

            btnConfigurationMOSS.Click += new Microsoft.Office.Core.

                _CommandBarButtonEvents_ClickEventHandler(configurationMOSS_Click);

            cmdSaveToMOSS.Visible = true;

Este código crea un elemento menú y le agrega dos opciones (‘btnSaveToMOSS’ y ‘btnConfigurationMOSS’). A continuación establece sus propiedades y asigna los event handlers a sendas rutinas que se ejecutarán al pulsar sobre ellas.

void saveToMOSS_Click(Microsoft.Office.Core.CommandBarButton Ctrl, ref bool CancelDefault)

    CancelDefault = true;

    MessageBox.Show("Save");

void configurationMOSS_Click(Microsoft.Office.Core.CommandBarButton Ctrl, ref bool CancelDefault)

    CancelDefault = true;

    MessageBox.Show("Config");

Conectar con un servidor MOSS/WSS con diferentes credenciales de usuario:

En algunas ocasiones tal vez nos interese conectar con un sitio de SharePoint y no hacer uso de las credenciales predeterminadas (por defecto el token del usuario de Windows). En estos casos, debemos hacer uso de la clase ‘System.Net.NetworkCredential’, pasando los valores de usuario y password (y opcionalmente dominio) para acceder al sitio. En este caso he creado unas sencillas funciones que devuelven un objeto de tipo ‘ICredentials’ que posteriormente usaremos en la propiedad ‘Credentials’ de los proxies de los servicios Web:

public static System.Net.ICredentials getCredentials()

    return System.Net.CredentialCache.DefaultCredentials;

public static System.Net.ICredentials getCredentials(string user, string password, string domain)

    return new System.Net.NetworkCredential(user, password, domain);

Interpretar el resultado devuelto por los servicios Web (LINQ to XML):

En el post anterior vimos que el resultado devuelto por los métodos de un servicio Web dista mucho de ser fácilmente interpretable, ya que nos devuelve un objeto de tipo XmlNode, de modo que debemos analizar el DOM para obtener el resultado deseado. En nuestro caso, vamos a realizar una llamada al método ‘GetWebCollection()’, que devuelve un XmlNode con los nombres de las webs (sites) de un sitio de SharePoint. Pero vamos a utilizar LINQ to XML para obtener sólo los elementos de un tipo determinado, y además vamos a obtener aquellos atributos que nos interesan. Y lo mejor es que todo se hace una sola sentencia:

public static List<SPSiteInfo> getSiteSubSites(websProxy.Webs sharePointWebs)

try

        XmlNode websResult = sharePointWebs.GetWebCollection();

        XDocument results = XDocument.Parse(websResult.OuterXml);

        XName name = XName.Get("Web", "http://schemas.microsoft.com/sharepoint/soap/");

        var webs = from item in results.Descendants(name)

                   select new SPSiteInfo

                       item.Attribute("Title").Value,

                       item.Attribute("Url").Value

);

        return webs.ToList();

    catch (Exception ex)

        throw ex;

A destacar en el código anterior el uso de un elemento XName para obtener sólo los elementos de tipo Web:

A continuación basta con seleccionar los atributos deseados de cada elemento XML (en nuestro caso título y url) e ir creando objetos que almacenaremos en una colección. Aquí utilizo una sencilla clase llamada ‘SPSiteInfo’ para devolver una lista genérica. Esta clase tiene sólo dos propiedades de tipo string (Title y URL) y un constructor en el que le pasamos ambos valores:

public class SPSiteInfo

    public string Title { get; set; }

    public string URL { get; set; }

    public SPSiteInfo()

//

    public SPSiteInfo(string title, string url)

        Title = title;

        URL = url;

De este modo, ya tenemos una función que nos devuelve una colección de objetos ‘SPSiteInfo’. Emplearemos este mismo procedimiento para recuperar las bibliotecas de documentos de un sitio, las carpetas de una biblioteca de documentos, e incluso las columnas de una biblioteca de documentos.

Pero ello lo veremos en el próximo post, que hay que volver a las trincheras... :-)

PD – Os recuerdo que al final de la serie publicaré el código fuente del proyecto de ejemplo.

** crossposting desde el blog de Lluís Franco en geeks.ms **

SharePoint 2007 + Outlook 2007: Guardar correos de forma masiva (III)

lfranco — Wed, 04 Feb 2009 16:22:00 GMT

Entradas anteriores de la serie:

SharePoint 2007 + Outlook 2007: Guardar correos de forma masiva (I)

SharePoint 2007 + Outlook 2007: Guardar correos de forma masiva (II)

Bueno, vamos a empezar a trabajar en nuestro Add-In!

Aunque antes, una aclaración: Como la mayoría de vosotros ya sabéis, en realidad quién hace el trabajo sucio no soy yo. Yo sólo me llevo los millones y la fama, mientras que la ingrata tarea de picar código (que no gusta a nadie :-P) se la dejo a mi Bender. Efectivamente, acabáis de descubrir uno de los secretos mejor guardados: Detrás de un MVP siempre hay alguien haciendo el trabajo real mientras ellos se llevan el mérito... Esto ha sido así desde que el pionero Rubén Vigón enseñó a codificar a su gato con Visual Basic 3.0, y poco a poco la mayoría hemos ido ‘adoptando’ esta acertada filosofía, que en mi caso me ha permitido apartarme de estas tareas mundanas y dedicarme a mis viñedos y mi afición desmedida por la calceta.

Así que en cuanto le propuse la idea del Add-In a Bender, le pareció que debíamos ponernos a ello en seguida (seguramente animado por la visión de las 2 cajas de un chardonnay excelente que recibirá como compensación al terminar). De modo que vamos a empezar en seguida.

Nota: Al terminar la serie publicaré el proyecto de ejemplo con todo el código al completo.
Un poco de paciéncia porque lo voy a ir haciendo sobre la marcha, ok?

Creando un proyecto Add-In para Outlook 2007

Esta es la parte más sencilla, ya que con Visual Studio 2008 (supongo que todos lo tenéis actualizado con el SP1) se incorporan las plantillas básicas para crear un proyecto de este tipo. Basta con iniciar un proyecto nuevo, y dentro de la categoría ‘Office’ encontraréis las plantillas para la versión 2007.

Esto crea un proyecto C# con las referencias necesarias para ejecutarse como complemento de Outlook, y proporciona el esqueleto básico para interceptar los eventos que se producen al cargar y descargar nuestro complemento.

using Outlook = Microsoft.Office.Interop.Outlook;

using Office = Microsoft.Office.Core;

namespace OutlookToMOSS

    public partial class ThisAddIn

        private void ThisAddIn_Startup(object sender, System.EventArgs e)

        private void ThisAddIn_Shutdown(object sender, System.EventArgs e)

        #region VSTO generated code

        /// <summary>

        /// Required method for Designer support - do not modify

        /// the contents of this method with the code editor.

        /// </summary>

        private void InternalStartup()

            this.Startup += new System.EventHandler(ThisAddIn_Startup);

            this.Shutdown += new System.EventHandler(ThisAddIn_Shutdown);

        #endregion

Observar que hay una región de código generado por el diseñador, que es la encargada de suscribir los eventos ‘StartUp’ y ‘StartDown’. En estos eventos, posteriormente agregaremos el código para inicializar y destruir nuestras referencias a los servicios Web de SharePoint. Además para poder interactuar con Outlook interceptaremos además un par de eventos más llamados ‘ItemContextMenuDisplay’ y ’FolderContextMenuDisplay’, que se producen al mostrar los menús contextuales de Outlook (por ejemplo, al pulsar el botón derecho sobre una selección de elementos de correo).

Agregando referencias a los servicios Web de SharePoint

Lo primero es lo primero, así que ya que vamos a interactuar con SharePoint, vamos a agregar referencias Web a aquellos servicios que vamos a consumir. Aunque tenemos una lista de varios servicios Web, de entrada vamos a trabajar con estos dos, aunque probablemente añadiremos otros más adelante:

Webs Web Service: Para acceder a la colección de sitios Web de un sitio de SharePoint.
Lists Web Service: Para acceder a la colección de bibliotecas de documentos de un sitio.

Para crear la referencia debemos conocer la URL de nuestro SharePoint (por ejemplo http://moss). Y agregar una ‘Service Reference’ al proyecto. Esto mostrará el cuadro de diálogo para agregar servicios WCF, pero como en nuestro caso vamos a agregar una referencia a un servicio Web 2.0 hay que dar un rodeo, ir a la parte avanzada y especificar que queremos crear una ‘Web reference‘:

Pulsar en el botón para mostrar las características avanzadas:

Especificar que deseamos agregar una ‘Web reference’ y en la nueva ventana especificar la URL del servicio, que siempre sigue esta nomenclatura:

En nuestro caso:

http://moss/_vti_bin/Webs.asmx

http://moss/_vti_bin/Lists.asmx

Especificando el nombre (en mi caso tengo por costumbre llamarlos websProxy y listsProxy).

Una vez añadidas veremos que en el árbol del proyecto aparece un elemento llamado ‘Web References’ que contiene las dos referencias a los servicios Web.

Interceptando eventos de Outlook

Ahora, para hacerlo más interesante, antes de ejecutar vamos a interceptar el evento ‘ItemContextMenuDisplay’ que se produce cuando el usuario muestra el menú contextual de los elementos de correo (dicho de otro modo, selecciona uno o varios emails y pulsa botón derecho). Para ello modificaremos la sección generada por el diseñador, agergando la siguiente línea al método InternalStartUp():

this.Application.ItemContextMenuDisplay +=

    new Microsoft.Office.Interop.Outlook.ApplicationEvents_11_ItemContextMenuDisplayEventHandler(

    Application_ItemContextMenuDisplay);

Y lógicamente ahora crearemos el método que será llamado al dispararse el evento:

        void Application_ItemContextMenuDisplay(

            Microsoft.Office.Core.CommandBar CommandBar,

            Microsoft.Office.Interop.Outlook.Selection Selection)

            websProxy.Webs sharePointWebs;

            sharePointWebs = new websProxy.Webs();

            sharePointWebs.Credentials = System.Net.CredentialCache.DefaultCredentials;

            XmlNode webs = sharePointWebs.GetWebCollection();

Este código es provisional, pero nos servirá para ver como se debe llamar a un método de un servicio Web. Primeramente se declara y se crea el objeto, a continuación se especifican las credenciales (en este caso las predeterminadas) y a continuación se llama al método GetWebCollection(), el cual nos devuelve un objeto... “oh sorpresa! oh dolor! oh campos de soledad, mustios collados...”, un objeto de tipo XmlNode. Efectivamente, los servicios Web de SharePoint trabajan con XML a tutiplén, con lo cual ya te aviso de que si no te gusta trabajar con XML tienes dos opciones: Dejar ahora mismo de leer este artículo escrito por Bender y hacer como yo disfrutando la de vida alegre, o bien esperar al próximo post, en el que veremos como LINQ to XML puede hacernos la vida un poco más fácil.

Ahoravamos a establecer un punto de ruptura en la última línea de código para ver que retorna el método GetWebCollection().

Estamos listos para ejecutar?

Pues si, ahora vamos a probar que sucede cuando ejecutamos nuestro proyecto. Como es un Add-In de Outlook va a arrancar éste primero y cuando hagamos click con el botón derecho sobre un elemento de correo entrará en acción el depurador permitiéndonos inspeccionar el valor de la variable ‘webs’, el cual os muestro a continuación, para que os asusteis un poco (hacer click en la imagen para verla más grande):

Mañana espero poder continuar con la serie. Y veremos cómo agregar elementos a los menús de Outlook, y cómo LINQ to XML nos va a permitir trabajar más cómodamente con los datos devueltos por los métodos de los servicios Web. Que todos sabemos de las bondades de XML, pero trabajar con atributos nunca resulta tan sencillo como trabajar con colecciones de objetos genéricos, verdad?

Pues eso, mañana más... que ahora me toca manicura y luego clase de tenis :-P

** crossposting desde el blog de Lluís Franco en geeks.ms **

SharePoint 2007 + Outlook 2007: Guardar correos de forma masiva (II)

lfranco — Tue, 03 Feb 2009 14:08:00 GMT

Entradas anteriores de la serie:

SharePoint 2007 + Outlook 2007: Guardar correos de forma masiva (I)

Vale, vamos a empezar a escribir la carta a los reyes magos:

Queridos reyes magos,

Este año me he portado muy bien así que me pido un add-in para Outlook que sirva para guardar los correos en bibliotecas de documentos de SharePoint, y que tenga las siguientes cositas:

Que se integre con los menús de Outlook, para poder seleccionar varios correos y copiarlos a la biblioteca que yo elija.
Que funcione tanto para MOSS como para WSS, para poder guardar correos en un servidor WSS que tengo en hosting en USA.
Que permita cambiar la ubicación del servidor de SharePoint para poder guardar los correos en el que me interese.
Que permita cambiar las credenciales de usuario, para permitir conectarme a diferentes sitios.
Que se encargue de crear las columnas necesarias para guardar los metadatos del elementos de correo (De, Para, Asunto, Enviado).
Que cuando guardemos una cantidad importante de correos no detenga la ejecución de Outlook, y podamos seguir trabajando mientras éstos se copian.
Y un detalle importante: Que tenga control de versiones, por si guardo dos veces el mismo elemento que me mantenga un histórico.

Y para desarrollar algo así necesitaremos saber varias cosas, por ejemplo:

Cómo crear un complemento para Office (VSTO).
Cómo conectar con un servidor MOSS/WSS con diferentes credenciales de usuario (System.Net.NetworkCredential)
Cómo acceder a los sitios y listas de un site de MOSS/WSS (servicios Web de SharePoint).
Cómo interpretar la información XML devuelta por los servicios (LINQ to XML).
Cómo guardar un fichero en una biblioteca de documentos de SharePoint con control de versiones (DocLibHelper).
Cómo ejecutar distintos threads y mostrar el progreso (Callbacks).
Cómo distribuir nuestro complemento, creando un archivo MSI (Windows Installer packages).

Y seguramente me dejo unas cuantas cosillas… pero ya las iremos abordando a medida que nos las encontremos. Al fin y al cabo esto es un proyecto de ejemplo y personal, así que sintiéndolo mucho no voy a utilizar SCRUM ;-)

Un saludo y mañana prometo empezar con el tema!

** crossposting desde el blog de Lluís Franco en geeks.ms **

SharePoint 2007 + Outlook 2007: Guardar correos de forma masiva (I)

lfranco — Mon, 02 Feb 2009 11:16:00 GMT

Es obvio que SharePoint es uno de los mayores productos de Microsoft, y que ha supuesto una revolución en el entorno colaborativo empresarial. Hoy en día esta herramienta hace posible que la información fluya entre los integrantes de una organización, y eso ha aumentado mucho la productividad y los procesos de trabajo de la empresa, algo que siempre agradecen los gestores :-)

Es obvio también que una plataforma de este calibre tiene muchas cosas a mejorar, ya que es todavía un “recién nacido” (aunque lleve ya tres versiones como producto). De forma que hay unos cuantos huecos que deben rellenarse con horas de ardua programación... algo que desespera a más de uno. Mucha gente me pregunta “¿pero cómo es posible que esto no esté implementado?”, y mi respuesta acostumbra a ser “pueeees... no tengo ni idea chico, pero lo bueno es que disponemos de un modelo de objetos que hace posible que lo implementes tu mismo.”

La verdad es que es más que posible que muchas de estas pequeñas cositas se implementen en la futura y deseada siguiente versión (de la que muy pocos elegidos saben algo), pero hasta entonces nos encontramos con algunas cosas que hay que hacer ‘a mano’.

Precisamente la última con la que me he encontrado (para mi sorpresa) se trata de que la integración de Outlook 2007 con SharePoint 2007 no es todo lo buena que debería, o más bien que falta alguna característica que encuentro “básica”.

En este caso se trata de la clasificación de elementos de correo en bibliotecas de documentos de SharePoint. Sería estupendo poder clasificar nuestros correos en bibliotecas de documentos con un simple “Guardar como…”, pero esto sólo se puede realizar cuando guardamos los correos de forma individual, ya que deben guardarse como ficheros MSG. Resulta que por algún designio divino esta opción no está disponible cuando seleccionamos varios elementos, y claro, ya sabemos que no es una opción válida para un gestor que está muy ocupado intentando salvar el mundo ;-) y menos en los tiempos que corren, en los que hay que salir de esta crisis a golpe de reuniones de high-level y comités de dirección, y no estamos para dilapidar el tiempo en tareas repetitivas, verdad?

Bueno, al grano que me estoy yendo... el tema es que como no he encontrado una forma de hacerlo, me he propuesto crear un add-in para Outlook, que permita guardar elementos de correo en bibliotecas de documentos de SharePoint. Y a medida que lo vaya desarrollando iré posteando algunas de las cosas interesantes de este desarrollo (cómo crear un proyecto de add-in para Outlook con VSTO, cómo interactuar con la aplicación host, acceder a los servicios Web de SharePoint, cómo distribuir el Add-In, etc). Y al final postear el código de ejemplo o crear un proyecto en codeplex para la comunidad. De este modo servirá de ejemplo (aunque sea malo :-P) y tal vez a alguien más podrá serle útil.

En el próximo post empezaremos a planificar el desarrollo. Saludos y hasta pronto,

** crossposting desde el blog de Lluís Franco en geeks.ms **

Series: Resumen de los enlaces

lfranco — Thu, 23 Oct 2008 08:24:52 GMT

Últimamente estoy recibiendo bastantes correos preguntándome cosas acerca de las series de posts que publiqué hace un tiempo. Os dejo aquí un resumen de los enlaces y el código fuente disponible en ellas. Ya estaba todo publicado pero de forma dispersa, así que aquí lo teneis todo juntito.

Aviso: Todas las series son ejemplos reales que muestran cómo realizar algunas de las tareas cotidianas (o no tanto) mediante C#. En ningún caso pretenden ser aplicaciones reales, de modo que deben tomarse como lo que realmente son: Meros ejemplos didácticos.

Acceder a la caché de Internet Explorer

Resumen:

Ejemplo de cómo crear un servicio de Windows que monitoriza la caché de archivos temporales de Internet Explorer y exporta un fichero log a una ubicación remota (por si el usuario decide vaciar la caché). Contiene ejemplos de cómo usar las API de acceso a la caché, cómo serializar objetos, realizar impersonation, y cómo crear y distribuir un servicio de Windows.

Artículos:

Acceder a la caché de Internet Explorer (I)
Acceder a la caché de Internet Explorer (II)
Acceder a la caché de Internet Explorer (III)
Acceder a la caché de Internet Explorer (IV)
Acceder a la caché de Internet Explorer (V)

Código de ejemplo:

Accediendo al directorio activo de la organización desde .NET

Resumen:

Ejemplo de cómo crear una aplicación Windows que accede al directorio activo de la organización. Contiene ejemplos de cómo validar unas credenciales (usuario y password) en un dominio, cómo realizar impersonation para ejecutar nuestra aplicación con los credenciales de otro usuario, recuperar los nombres de las propiedades del objeto user del AD, y cómo obtener información y los grupos a los que pertenece el usuario actual.

Artículos:

Accediendo al directorio activo de la organización desde .NET (I)
Accediendo al directorio activo de la organización desde .NET (II)
Accediendo al directorio activo de la organización desde .NET (III)
Accediendo al directorio activo de la organización desde .NET (IV)

Corrección función getUserLDAPProperties

lfranco — Thu, 10 Jul 2008 09:01:18 GMT

Corrección aplicable al post:

http://geeks.ms/blogs/lfranco/archive/2008/07/08/accediendo-al-directorio-activo-de-la-organizaci-243-n-desde-net-iv.aspx

Ayer estuve revisando una de las funciones de la librería LDAPservices, que se encarga de devolver los nombres de las propiedades del objeto usuario dentro del AD. Hoy os publico una corrección, ya que observé que la función no devolvía correctamente todos los nombres de propiedades.

Este bug es producido porque en la función se utiliza un objeto DirectorySearcher para devolver todos los objetos de tipo usuario en el AD, a continuación lee los nombres de las propiedades del primer usuario encontrado y los inserta en una colección. A continuación la función no continúa procesando el resto de usuarios, ya que deberían tener las mismas propiedades, no? Pues no. Para mi sorpresa resulta que sólo se devuelven aquellas propiedades del usuario que han sido informadas:

public static List<string>

    getUserLDAPProperties(string LDAPURL)

    List<string> properties =new List<string>();

    DirectoryEntry entries = new DirectoryEntry(LDAPURL);

    DirectorySearcher searcher = new DirectorySearcher(

        entries, "(&(objectCategory=person)(objectClass=user))");

try

        foreach (SearchResult result in searcher.FindAll())

            foreach (string property in

                result.GetDirectoryEntry().Properties.PropertyNames)

                properties.Add(property);

            break;

    catch (Exception ex)

        throw ex;

    return properties;

Para solucionar este bug, hay que procesar las propiedades de todos los usuarios, quedando el código de la función así como sigue:

foreach (SearchResult result in searcher.FindAll())

    foreach (string property in

        result.GetDirectoryEntry().Properties.PropertyNames)

        if(!properties.Contains(property)) properties.Add(property);

Como veis, se suprime el break que terminaba el bucle y se añade una condición para que se agreguen a la colección sólo aquellos nombres de propiedad que no se han agregado previamente.

Saludos y happy coding!!!

** crossposting desde el blog de Lluís Franco en geeks.ms **

Accediendo al directorio activo de la organización desde .NET (IV)

lfranco — Tue, 08 Jul 2008 12:27:24 GMT

Buscar

Hoy vamos a buscar. Buscar elementos en el AD dentro de nuestra organización, y como lo más habitual es buscar usuarios o grupos he creado algunas funciones para facilitar esta tarea dentro de la clase LDAPServices (os dejo para vosotros ampliarlas para buscar equipos, por ejemplo).

También veremos cómo extraer los nombres de las propiedades de un objetos del AD, ya que en ocasiones queremos filtrar o devolver el valor de una propiedad de un objeto y no sabemos cómo se llama esta propiedad. Por ejemplo, para devolver el teléfono de un usuario en el AD hay que preguntar por el valor de la propiedad 'telephoneNumber'.

Tal vez más adelante (si tengo tiempo) lo ampliemos un poco. Me gustaría realizar un post acerca de cómo realizar un mapeador de propiedades para asignar los valores de las propiedades de objetos LDAP a objetos de nuestra aplicación. Esto podría ser muy útil por ejemplo, para importar los valores de nuestros usuarios de AD a una tabla de empleados.

Antes de empezar quiero comentaros que para poder realizar todo esto va a ser necesario agregar una referencia a System.DirectoryServices a nuestro proyecto. Pero vamos ya con estos nuevos métodos de LDAPServices:

getLDAPFilterString - Devuelve una cadena de consulta en formato LDAP query, que permite filtrar los objetos que deseamos devolver. Esta función filtra aquellos carácteres no deseados para evitar posible inyección de código LDAP por parte de un usuario (aunque es muy mejorable, estoy seguro que mi JoseMariCariño sería capaz de sacar información de aquí, casi me apuesto algo).

public enum LDAPFilterType

    UsersAndGroups,

    OnlyUsers,

    OnlyGroups

public static string

    getLDAPFilterString(LDAPFilterType Type, string Filter)

    Filter = Filter.Replace("&","");

    Filter = Filter.Replace("|","");

    Filter = Filter.Replace("*", "");

    string FilterByName = "(samAccountName=*{0}*)";

    string f = string.Empty;

    switch (Type)

        case LDAPFilterType.OnlyUsers:

            f = "(&(objectCategory=person)(objectClass=user){0})";

            break;

        case LDAPFilterType.OnlyGroups:

            f = "(&(objectCategory=Group){0})";

            break;

        case LDAPFilterType.UsersAndGroups:

            f = "(|(&(objectCategory=person)(objectClass=user){0})(&(objectCategory=Group){0}))";

            break;

    if (Filter == string.Empty)

        return string.Format(f, string.Empty);

    else

        return string.Format(f, string.Format(FilterByName, Filter));

getItemsInLDAP - Basándose en el método anterior, realiza la consulta al AD y devuelve una lista con los objetos coincidentes. Su funcionamiento se basa en un objeto DirectoryEntry, que apunta al AD que se le ha pasado como aergumento. Y en un objeto DirectorySearcher, que es el que realmente se encarga de buscar las entradas coincidentes con el filtro en el DirectoryEntry.

public static List<string>

    getItemsInLDAP(string LDAPURL, LDAPFilterType type, string criteria)

    List<string> items = new List<string>();

    DirectoryEntry entries = new DirectoryEntry(LDAPURL);

    string filter = getLDAPFilterString(type, criteria);

    DirectorySearcher searcher = new DirectorySearcher(

        entries, filter);

try

        foreach (SearchResult result in searcher.FindAll())

            items.Add((string)result.Properties["samAccountName"][0]);

    catch (Exception ex)

        throw ex;

    return items;

Para probar esta funcionalidad basta con tener un TextBox en el que introducir el criterio de búsqueda y un ComboBox en el que especificar que objetos deseamos buscar. Así cómo un CommandButon para lanzar la consulta y un ListBox en el que mostrar los resultados:

El código es muy sencillo. Basta con asignar el valor devuelto por la función getItemsInLDAP al DataSource de la lista.

private void cmbSearch_Click(object sender, EventArgs e)

try

        string dcName = LDAPServices.getLDAPDomainName(txtDomain.Text);

        List<string> items = LDAPServices.getItemsInLDAP(dcName,

            (LDAPServices.LDAPFilterType) cmbType.SelectedIndex, txtCriteria.Text);

        lstItems.DataSource = items;

    catch (Exception ex)

        MessageBox.Show(ex.Message,

             Application.ProductName,

             MessageBoxButtons.OK,

             MessageBoxIcon.Exclamation);

getUserLDAPProperties - Devuelve una lista de cadenas con los nombres de las propiedades de un objeto User dentro del AD. Cabe observar que el esquema del AD es variable, con lo que las propiedades devueltas pueden cambiar. Por ejemplo, productos que se integran fuertemente con AD como Exchange agregan propiedades a los objetos usuario y grupo.

public static List<string>

    getUserLDAPProperties(string LDAPURL)

    List<string> properties =new List<string>();

    DirectoryEntry entries = new DirectoryEntry(LDAPURL);

    DirectorySearcher searcher = new DirectorySearcher(

        entries, "(&(objectCategory=person)(objectClass=user))");

try

        foreach (SearchResult result in searcher.FindAll())

            foreach (string property in

                result.GetDirectoryEntry().Properties.PropertyNames)

                properties.Add(property);

            break;

    catch (Exception ex)

        throw ex;

    return properties;

De este modo podemos saber las propiedades de un objeto dentro de nuestro AD. Esto es más importante de lo que parece, ya que cuando buscamos elementos dentro del AD, no se devuelven todas las propiedades de forma predeterminada. Para agregar el valor de una propiedad a los resultados de la búsqueda ésta debe añadirse explícitamente mediante la colección PropertiesToLoad:

searcher.PropertiesToLoad.Add("telephoneNumber");

Y luego comprobar si existe valor devuelto, ya que es posible que no exista o no devuelva valor:

if (r.Properties("telephoneNumber").Count > 0)

//

Y hasta aquí el cuarto capítulo de esta serie. Espero que os sea útil, recordar que en esta ocasión el código completo lo publiqué en el post anterior.

Nos vemos pronto!
Un saludo desde Andorra,

** crossposting desde el blog de Lluís Franco en geeks.ms **

Accediendo al directorio activo de la organización desde .NET (III)

lfranco — Fri, 04 Jul 2008 15:45:18 GMT

En vista a que bastante gente me ha pedido si puedo publicar ya el código del proyecto de ejemplo, he decidido publicarlo ahora en lugar de esperar al último post de la serie. En caso que se realicen variaciones en el código, las publicaré posteriormente.

Aquí lo teneis, publicado en skydrive (*):

(*) En ocasiones, al realizar cross-posting a otros blogs desde el original de geeks.ms, tal vez no aparezca correctamente el enlace a skydrive. Si es así, os recomiendo que visitéis el post original en geeks.ms y realicéis la descarga desde éste.

En el post anterior, os dije que en el siguiente (este post) mostraríamos cómo realizar la suplantación (Impersonate) de usuario de Windows para ejecutar nuestra aplicación con otras credenciales. Sin embargo, como ésto ya lo mostré en otro post de una serie anterior, lo doy por explicado y así avanzamos un poco más.

System.Net.NetworkInformation

Antes de entrar al trapo, un pequeño apunte. Apuntaros este espacio de nombres, que hemos utilizado para obtener algunos datos básicos para el proyecto, y que contiene un montón de métodos que devuelven información muy interesante sobre el tráfico y estadísticas de red.

LDAPServices

Vamos a ir comentando algunas de los métodos que proporciona esta clase. Como os comenté son todos estáticos, por lo que no es necesario instanciar un objeto para invocarlos. Empecemos:

sIDtoString - Trabajando con el AD constantemente vamos a encontrarnos con los llamados SID (identificadores de seguridad). Este método se encarga de transformar un SID (array de bytes) en una cadena de texto que pueda ser mostrada al usuario.

public static string

    sIDtoString(byte[] sidBinary)

    SecurityIdentifier sid = new SecurityIdentifier(sidBinary, 0);

    return sid.ToString();

getNTAccountName - Devuelve el nombre del objeto dentro del AD a partir de su SID. Por ejemplo, a partir de un identificador de seguridad como {S-1-5-12-7623811015-3361044348-030300820-1013} retorna un string con formato: 'DOMINIO\NombreObjeto'.

public static string

    getNTAccountName(string wksid)

    SecurityIdentifier sid = new SecurityIdentifier(wksid);

    NTAccount account = (NTAccount)sid.Translate(typeof(NTAccount));

    return account.Value;

getADUserMemberOf - Devuelve un diccionario con los grupos a los que pertenece un usuario. Espera un argumento de tipo token de seguridad (habitualmente utilizaremos el WindowsIdentity.GetCurrent().Token) y el diccionario genérico devuelto es de tipo <string, IdentityReference>.

public static Dictionary<string, IdentityReference>

    getADUserMemberOf(IntPtr logonToken)

    Dictionary<string, IdentityReference> groups =

        new Dictionary<string, IdentityReference>();

    WindowsIdentity user = new WindowsIdentity(logonToken);

    IdentityReferenceCollection irc = user.Groups;

    foreach (IdentityReference ir in irc)

        groups.Add(getNTAccountName(ir.Value), ir);

    return groups;

(*) Al ir escribiendo el artículo me he dado cuenta de que esta función podría ser optimizada, aprovechando algunas de las nuevas características de C# 3.0, incorporadas en Visual Studio 2008. De modo que podría ser re-escrita del siguiente modo ¡en tan sólo 3 líneas!

public static Dictionary<string, IdentityReference>

    getADUserMemberOf2(IntPtr logonToken)

    WindowsIdentity user = new WindowsIdentity(logonToken);

    var groups = from g in user.Groups select g;

    return groups.ToDictionary(p => getNTAccountName(p.Value));

¿Menudo cambio, verdad? Observar el uso de:

Inferencia de tipos (var)
Palabras clave de consulta (from, in, select)
Expresiones lambda en la llamada al método extensor ToDictionary (p => getNTAccountName(p.Value))

La verdad es que en cuanto empiezas a usar estas mejoras te 'enganchan'. No sabeis la cara de bobo que se me queda cuando a veces abro el editor de VB6.0 (si, habéis oído bien) para realizar alguna modificación en aplicaciones que todavía no se han migrado a .NET (y lo que les queda... :-P).

Hasta aquí algunos de los métodos que contiene la clase LDAPServices. En el próximo post veremos cómo obtener la lista de propiedades de un objeto user dentro del directorio activo, así cómo realizar búsquedas de objetos dentro del directorio.

No vemos pronto,

** crossposting desde el blog de Lluís Franco en geeks.ms **

Accediendo al directorio activo de la organización desde .NET (II)

lfranco — Mon, 30 Jun 2008 13:53:07 GMT

En el post anterior vimos que en ocasiones nuestra aplicación deberá acceder a los datos que contiene el directorio activo de nuestra organización, ya sea para buscar elementos, validar credenciales, etc.

Hoy nos centraremos en los objetos del framework que nos permiten realizar esto, empezando por el objeto WindowsIdentity, que nos acompaña desde la versión 1.0 del framework, y que representa un usuario de Windows.

WindowsIdentity

Representa un usuario de Windows. Dispone de un método GetCurrent() que devuelve una referencia al usuario de Windows que está ejecutando la aplicación y que por defecto será el usuario actual de Windows.

En nuestro ejercicio vamos a utilizar este objeto para mostrar en la barra de estado algo de información sobre el usuario actual. El nombre y token, así como el contexto de suplantación y diversa información cómo si está autenticado, es de sistema, etc.

El código es muy sencillo y para usarlo sólo debemos tener en cuenta haber importado el espacio de nombres System.Security.Principal:

private void RefreshUserInformation()

    WindowsIdentity user = WindowsIdentity.GetCurrent();

    lblUser.Text = string.Format("User: {0}", user.Name);

    lblToken.Text = string.Format("Token: {0}", user.Token.ToString());

    lblImpersonating.Text = string.Format("Impersonating: {0}", user.ImpersonationLevel.ToString());

    lblIsAnonymous.Text = string.Format("Is Anonymous: {0}", user.IsAnonymous.ToString());

    lblIsAuthenticated.Text = string.Format("Is Authenticated: {0}", user.IsAuthenticated.ToString());

    lblIsGuest.Text = string.Format("Is Guest: {0}", user.IsGuest.ToString());

    lblIsSystem.Text = string.Format("Is System: {0}", user.IsSystem.ToString());

    if (sec.ImpersonationContext == null)

        cmdImpersonateApplicationAsUser.Enabled = true;

        lblUser.ForeColor = Color.Black;

        lblImpersonating.ForeColor = Color.Black;

    else

        cmdImpersonateApplicationAsUser.Enabled = false;

        lblUser.ForeColor = Color.Red;

        lblImpersonating.ForeColor = Color.Red;

    cmdUndoImpersonation.Enabled = !cmdImpersonateApplicationAsUser.Enabled;

Lo único a destacar es que en caso de que exista suplantación (ImpersonationContext distinto de nulo), mostraremos algunos campos en color rojo, para destacar que este usuario es distinto del que inició sesión en Windows.

LDAPServices

En este proyecto he creado una clase que proporciona una serie de funcionalidades comunes, su nombre es LDAPServices y encapsula una serie de métodos estáticos, para facilitar el trabajo con LDAP. En los próximos posts detallaremos el uso de estos métodos:

SecurityContext

También aparece la clase llamada SecurityContext que ya hemos visto en la serie de posts sobre acceder a la caché de IE, que encapsula toda la lógica necesaria para impersonar nuestra aplicación y que se ejecute con otras credenciales de usuario de Windows.

Esta clase expone una propiedad de tipo WindowsImpersonationContext que devuelve información sobre si está realizando suplantación, y que en caso afirmativo permite terminarla mediante el método Undo(). También expone dos métodos LogonUser y ImpersonateUser, que permiten respectivamente validar unas credenciales de usuario contra un dominio y empezar un contexto de suplantación.

En el próximo post veremos cómo realizar esta suplantación y cómo recabar más información del usuario actual (por ejemplo a que grupos de Windows pertenece el usuario actual).

Hasta entonces!

** crossposting desde el blog de Lluís Franco en geeks.ms **

Accediendo al directorio activo de la organización desde .NET (I)

lfranco — Wed, 11 Jun 2008 18:16:35 GMT

Creo que me estoy aficionando a las series ~~de posts no de la tele~~, ya que acabo de terminar la serie de artículos acerca de cómo acceder a la caché de Internet Explorer y ya estoy planteándome una nueva, sobre acceder al directorio activo mediante una aplicación realizada con C#. Esta serie, al igual que la anterior intentará ser lo más directa y práctica posible, y del mismo modo al final de la serie publicaré el código completo del ejemplo para su descarga.

El motivo...

...de esta serie es porque tanto en los foros como en los grupos de notícias, es muy común encontrar preguntas muy variadas acerca de cómo acceder a LDAP desde una aplicación .NET. Así que me he planteado empezar una serie de posts en los que mostraremos varios ejemplos: Mostrar información del usuario actual de Windows, averiguar los grupos a los que pertenece, validar credenciales contra un dominio para saber si son correctas, impersonar nuestra aplicación para que se ejecute con las credenciales de otro usuario, buscar usuarios o grupos en LDAP, extraer la lista de propiedades del objeto usuario, etc.

¿LDAP o Directorio Activo?

Antes de empezar quiero hacer una aclaración: ¿Es lo mismo LDAP que Directorio Activo? No, no es lo mismo.

LDAP es el acrónimo de (Lightweight Directory Access Protocol) que es es un protocolo a nivel de aplicación que permite el acceso a un servicio de directorio ordenado y distribuido para buscar diversa información en un entorno de red. Habitualmente se utiliza para acceder a la información almacenada de usuarios, grupos y equipos de una organizació y existen muchas implementaciones de este protocolo, desde Microsoft hasta Novell pasando por Red Hat, iPlanet u OpenLDAP.

El directorio Activo o AD es la implementación de LDAP realizada por Microsoft en su família Windows Server. Al igual que LDAP permite acceder a distintos tipos de objetos almacenados que representan los elementos de la organización. Cada uno de estos objetos tendrá atributos que permiten identificarlos en modo unívoco (por ejemplo, los usuarios tendrán campo "nombre", campo "email", etc..., las impresoras de red tendrán campo "nombre", campo "fabricante", campo "modelo", campo "usuarios que pueden acceder", etc). Toda esta información queda almacenada en Active Directory replicándose de forma automática entre todos los servidores que controlan el acceso al dominio.

Situaciones cotidianas

Nosotros los desarrolladores, como creadores de aplicaciones que deben coexistir en un entorno corporativo, cada vez nos encontramos en más ocasiones en las que nuestra aplicación debe utilizar los usuarios y grupos del AD de la empresa, en lugar de almacenar una base de datos propia de usuarios y grupos. Incluso me atrevería a decir que la frontera entre una aplicación madura, de uso corporativo, y que se integre con otras aplicaciones y servicios, a veces estriba en detalles como éste.

Hoy en día cada vez más empresas disponen de la figura del administrador del AD, que gestiona todos los datos de los empleados de la misma, de modo que ¿para que van a mantener otra base de datos con los usuarios de una aplicación, si éstos ya existen en el AD? Incluso puede ser peor ¿os imagináis cuántas aplicaciones funcionan de este modo? ¿Debemos mantener X bases de datos de usuarios por X aplicaciones? Esto puede ser el caos... ¡imaginaos la de datos duplicados que existen y lo difícil que resulta mantenerlos!

Gracias al .NET framework, hoy en día podemos integrar nuestras aplicaciones con el AD de la empresa, de forma que podamos aprovechar la ventaja de contar con un repositorio centralizado. De este modo podremos dejar en manos del administrador del AD la creación de usuarios, grupos y cómo se relacionan entre ellos, y nosotros encargarnos de lo que realimente nos importa: La aplicación.

En el próximo post empezaremos a construir nuestra aplicación de ejemplo, y para ello contaremos con la ayuda del namespace System.Security.Principal y de System.DirectoryServices... hasta entonces!

** crossposting desde el blog de Lluís Franco en geeks.ms **