SharePoint List View Permission Manager

Aktualizacja 2010-03-18: zaktualizowałem kod przykładu gdyż jak głupi zapomniałem, że w SharePoint może istnieć więcej witryn niż jedna a mój kod powodował, że te inne nie działały :)

Wydaje mi się, że wspomniałem już o takim rozwiązaniu u siebie na blogu, jednakże nigdy się nie zagłębiłem w to jak można to rozwiązać. Pomysł chodził za mną już od początku 2008 roku, nawet zrobiłem wstępną implementację i ona działała. Jednakże dopiero dzisiaj dzięki Przemkowi przysiadłem do tego.

Ale o co chodzi?

WSS/MOSS nie udostępniają mechanizmu zarządzania uprawnieniami do widoków na listach, przez co czasami tworzy się naprawdę pokrętne rozwiązania – własne GridView, Web Part z określonym widokiem czy nawet Query Web Part. Zawsze jednak rozwiązanie to nie jest takie dobre jak byśmy chcieliby ono było.

Istnieje inna opcja?

Jasne, że tak! Swojego czasu musiałem przeciążyć jeden przycisk w SharePoint by jego obsłużyć jego akcję tak jak klient chciał. Była to zabawa na całego gdyż nie okazało się to takie proste jak wyglądało a wszystko przez powalony typ ankiety w SharePoint.

Wtedy także dotarło do mnie, że nie tylko tą kontrolę mogę przeciążyć i w ten sposób zacząłem kombinować co można jeszcze z tym SharePointem zrobić :) Jednym z pomysłów jaki był to właśnie dodanie zarządzania uprawnieniami, ale podobnie jak House, jak już odkryłem tajemnice to mnie to po prostu przestało bawić.

Jak można do tej opcji dojść?

Szczerze mówiąc, ja chyba miałem szczęście. Ogólnie wiedziałem co chcę zrobić, otworzyłem Reflecotra i zacząłem przeszukiwać bibliotekę SharePoint pod słowami pod którymi myślałem, że kontrolka może się czaić. Pierwszy strzał okazał się trafiony: przeszukałem informacje po słowie kluczowym View które ograniczyło mi listę do niezbędnych elementów. Tam natrafiłem na klasę ViewSelector. Wiedząc, że SharePoint korzysta z szablonów starałem się znaleźć wykorzystanie tej kontrolki w DefaultTemplates.ascx – sama kontrolka nie była wykorzystana, jako tako, ale nazwy szablonów zawierały tą część nazwy, która mnie interesowała. W ten sposób dotarłem do kontrolki o nazwie ViewSelectorMenu. Po szybkim zapoznaniu się z jej implementacją (reflector) stwierdziłem, że da się ją przeciążyć :)

Jak można taką kontrolkę oprogramować?

Nie jest to tak skomplikowane jakby się wydawało. To co trzeba zrobić to przeciążyć metodę AddMenuItems() – w niej zaś wywołać bazową implementację i następnie działać już na kontrolkach menu, które zostały przez klasę bazową utworzone. Cała implementacja polega na tym by przelecieć po wszystkich takich kontrolkach, pobrać adres URL na który przekierowują, dobrać się za pomocą jego do obiektu SPView i zebrać wszystkie te kontrolki które chcemy usunąć w jednym miejscu.

Przykładowy kod to realizujący:

protected override void AddMenuItems()
{
    base.AddMenuItems();

    IList<Control> controlsToRemove = new List<Control>();

    foreach (Control c in MenuTemplateControl.Controls)
    {
        if (c is MenuItemTemplate)
        {
            MenuItemTemplate menuItem = c as MenuItemTemplate;
            string url = menuItem.ClientOnClickNavigateUrl;

            // omitting EditView and etc.
            if (url.Contains("_layouts"))
                continue;

            int pos = url.IndexOf("?");

            if(pos != -1)
                url = url.Substring(0, pos);

            if (!DoseUserHavePermission(SPContext.Current.Web.GetViewFromUrl(url)))
            {
                controlsToRemove.Add(c);
            }
        }
    }
    foreach (Control control in controlsToRemove)
    {
        MenuTemplateControl.Controls.Remove(control);
    }
    
}

Teraz dzięki temu w metodzie DoseUserHavePermission mamy dostęp do SPView i możemy zadecydować co zrobić z danym widokiem (czy widok powinien być użytkownikowi wyświetlony czy też nie).

Mając kodowy kod to co możemy zrobić by go już przetestować to podpisać naszą dllkę, wrzucić ją do GAC oraz dodać do SafeControls w Web.Config. Ostatnim krokiem jest edycja szablonu. By można było naszą kontrolkę wykorzystać dodajemy rejestrację Tagu na górze kontrolki:

<%@Register TagPrefix="lineByLine" Assembly="LineByLine.ViewPermsManager, Version=1.0.0.0, Culture=neutral, PublicKeyToken=57af8fcf04e76604" namespace="LineByLine.ViewPermsManager"%>

I następnie podmieniamy wystąpienie tagu <SharePoint:ViewSelectorMenu> na nasz Tag. Robimy iisreset i sprawdzamy jak pięknie działa nasze rozwiązanie.

Jeżeli nie podoba się wam edycja pliku DefaultTemplates.ascx to można dany szablon przenieść do osobnego pliku ASCX (pamiętajcie o przeniesieniu/skopiowaniu Register dla kontrolek waszych i SharePointa). Taka zmiana wymaga także IISReset.

Czy istnieje już takie rozwiązanie na rynku?

Nie sądze, ponad rok temu jak podałem komuś takie rozwiązanie to był zdziwiony, że tak się da. DataPolis zaś wykorzystuje ViewSelectorMenu do ukrywania view, jeżeli osoba nie ma uprawnienia do kolumny. Dodatkowo rozwiązanie ich jest rozszerzone o Iterator jak i dodanie sprawdzania uprawnienia do WebService.

Przykładowe rozwiązanie

Nie pisał bym postu by tylko wam powiedzieć jak to można zrobić. Sprawdziłem to sam jeszcze dzisiaj i działa. Do postu załączam przykładowy projekt, który umożliwia wam zarządzanie uprawnieniami do widoku za pomocą prostej (bardzo prostej) listy zawierającej meta dane dla nazwy listy, nazwy widoku i nazwy grupy.

Solution składa się tak naprawdę z dwóch projektów, zmodyfikowanej wersji SPG dla SharePointa, w której zamiast mappera po stringach jest mapper po expression oraz zamiast po internal name mapowianie idzie po Id, oraz z głównego rozwiązania.

• Entities – zawierają tak naprawdę jedynie obiekty służące mapowaniu elementów konfiguracyjnych z list na obiekt i z obiektu na listy;
• Extensions – to są metody pomocnicze, które wykorzystuje w innych miejscach (na przykład aktualizacja elementu bez wywoływania event receiverów);
• Repositories – służą, jako dostęp do danych na liście wraz z mapowaniem obiektu na element listy i na odwrót. Jedynie repozytorium dostępu do uprawnień jest oprogramowane, jedynie z jedną metodą;
• Templates – zwiera przeciążony szablon dla ViewSelectorMenu;
• ViewPermsInstaller – jest to feature receiver, który konfiguruje SPG, tworzy listę zarządzania uprawnieniami dostępu. Dodatkowo zawarte tam się elementy rozwiązania takie jak delegate control i grupa menu;
• Fields – tutaj zawsze przechowuje mapowanie nazwy kolumny na jej GUID, dzięki czemu mogę zastosować łatwo expression w konfiguracji repozytorium. Ze względu na to, że nie korzystam z ContentType, ID pól są ustawiane z kodu;
• ViewPermsManager – jest to klasa która jest odpowiedzialna za sprawdzanie uprawnień;
• ViewPermsDelegateControl – jest to kontrolka, która sprawdza czy użytkownik jak wprowadził adres do View z palca to czy ma prawo widzieć to View, jeżeli nie to przekierowuje go na stronę z informacją o braku dostępu;
• ViewPermsSelectorMenu – jest to klasa która zarządza elementami wyświetlanymi w selektorze widoków.

Ogólnie nic skomplikowanego. Całe rozwiązanie nadaje się do deployu (wykorzystuje SharePoint Tools for VS 1.3). To co otrzymacie po zainstalowaniu to:

1) Menu z linkiem do listy zarządzającej

2) Banalny formularz do zarządzania uprawnieniami

3) Ograniczone View

4) Przekierowanie na stronę z błędem, jeżeli użytkownik nie ma uprawnień do widoku a wklepał z palca URL

To czego rozwiązanie nie obejmuje

To jest prosta implementacja pomysłu. Rozwiązanie jest tak zorganizowane, żebyście mogli łatwo kod rozszerzyć o dodatkowe elementy/dodatkową walidację.

Łatwiej będzie odpowiedzieć na pytanie co jest :)

• Ograniczenie elementów w wyborze View o te, które mają się pokazać danej grupie;
• Uprawnienia dotyczą każdego – nie sprawdzania czy osoba jest administratorem ;)
• Przekierowanie na stronę z błędem jeżeli osoba wklepała z palca URL do widoku.

Czyli za pomocą WebService wciąż będzie się można dostać do listy. Z poziomu kodu także. Jednakże nie powinno to mieć znaczenia skoro Target Audiences wystarczają ludziom to i to powinno wystarczyć :)

Na koniec

Z rozwiązaniem róbcie co chcecie :) modyfikujcie, edytujcie, dajcie tylko znać proszę czy wam się podoba i najważniejsze czy wam to działa. Oczywiście piwo też by było mile widziane :)

Jeżeli stworzycie coś fajnego na podstawie tego to też dajcie znać :) będzie na pewno miło :)

Link do rozwiązania.