Как найти контроллеры с атрибутами [Authorize], используя Reflection в C # (или Как создать динамическое меню Site.Master)

Question

Может быть, я должен сделать резервную копию и расширить область видимости, прежде чем погрузиться в заглавный вопрос ...

В настоящее время я пишу веб-приложение в ASP.NET MVC 1.0 (хотя у меня установлен MVC 2.0на моем ПК, поэтому я не ограничен до 1.0) - я начал со стандартного проекта MVC, который имеет базовое «Welcome to ASP.NET MVC» и отображает вкладки [Home] и [About]в правом верхнем углу.Довольно стандартный, верно?

Я добавил 4 новых класса Controller, назовем их «Астроном», «Биолог», «Химик» и «Физик».К каждому новому классу контроллера прикреплен атрибут [Authorize].

Например, для BiologistController.cs

[Authorize(Roles = "Biologist,Admin")]
public class BiologistController : Controller
{ 
    public ActionResult Index() { return View(); }
}

Эти теги [Authorize] естественным образом ограничивают, какой пользователь может получить доступ к различным контроллерам в зависимости от ролей, но я хочу динамически создать меню навверху моего сайта на странице Site.Master, основанной на ролях, в которых участвует пользователь.Так, например, если бы «JoeUser» был членом ролей «Астроном» и «Физик», в меню навигации было бы сказано:

[Домой] [Астроном] [Физик] [О нас]

И, естественно, в не будет список ссылок на страницу индекса контроллера "Биолог" или "Химик".

Или, если "JohnAdmin" был членом Role "Admin ", ссылки на все 4 контроллера будут отображаться на панели навигации.

Хорошо, теперь вы поняли идею ... Теперь для реального вопроса ...

---

Начиная с ответа от этой темы StackOverflow о динамическом менюВстраивая в ASP.NET , я пытаюсь понять, как бы полностью реализовать это.

В ответе предлагается расширить класс Controller (назовите его «ExtController»), а затем каждый новыйВсе, что унаследовано от ControlController от ExtController.

Я пришел к выводу, что мне нужно использовать Reflection в этом конструкторе ExtController, чтобы определить, к каким классам и методам прикреплены атрибуты [Authorize] для определения ролей.Затем, используя статический словарь, сохраните роли и контроллеры / методы в парах ключ-значение.

Я представляю это примерно так:

public class ExtController : Controller
{
    protected static Dictionary<Type,List<string>> ControllerRolesDictionary;

    protected override void OnActionExecuted(ActionExecutedContext filterContext)   
    {   
        // build list of menu items based on user's permissions, and add it to ViewData  
        IEnumerable<MenuItem> menu = BuildMenu();  
        ViewData["Menu"] = menu;
    }

    private IEnumerable<MenuItem> BuildMenu()
    {
        // Code to build a menu
        SomeRoleProvider rp = new SomeRoleProvider();
        foreach (var role in rp.GetRolesForUser(HttpContext.User.Identity.Name))
        {

        }
    }

    public ExtController()
    {
        // Use this.GetType() to determine if this Controller is already in the Dictionary
        if (!ControllerRolesDictionary.ContainsKey(this.GetType()))
        {
            // If not, use Reflection to add List of Roles to Dictionary 
            // associating with Controller
        }
    }
}

Это выполнимо?Если это так, как мне выполнить Reflection в конструкторе ExtController, чтобы обнаружить атрибут [Authorize] и соответствующие роли (если есть)

ТАКЖЕ!Не стесняйтесь выходить за рамки этого вопроса и предлагать альтернативный способ решения этой проблемы «Динамическое меню Site.Master на основе ролей».Я первый, кто признает, что это не лучший подход.

Answer 1

Хорошо, поэтому я решил усовершенствовать свой собственный класс Extended Controller, как я изначально предлагал.Вот очень простая версия.Я могу видеть различные способы сделать это лучше (расширяться дальше, ужесточать код и т. Д.), Но я думал, что предложу свои основные результаты, потому что я думаю, что есть много других людей, которые хотят что-то подобное, но, возможно, не хотят всеДоп.

public abstract class ExtController : Controller
{
    protected static Dictionary<string, List<string>> RolesControllerDictionary;
    protected override void OnActionExecuted(ActionExecutedContext filterContext)   
    {   
        // build list of menu items based on user's permissions, and add it to ViewData  
        IEnumerable<MenuItem> menu = BuildMenu();  
        ViewData["Menu"] = menu;
    }

    private IEnumerable<MenuItem> BuildMenu()
    {
        // Code to build a menu
        var dynamicMenu = new List<MenuItem>();
        SomeRoleProvider rp = new SomeRoleProvider();
        // ^^^^^INSERT DESIRED ROLE PROVIDER HERE^^^^^
        rp.Initialize("", new NameValueCollection());
        try
        {   // Get all roles for user from RoleProvider
            foreach (var role in rp.GetRolesForUser(HttpContext.User.Identity.Name))
            {   // Check if role is in dictionary
                if (RolesControllerDictionary.Keys.Contains(role))
                {   
                    var controllerList = RolesControllerDictionary[role];
                    foreach (var controller in controllerList)
                    {   // Add controller to menu only if it is not already added
                        if (dynamicMenu.Any(x => x.Text == controller))
                        { continue; }
                        else
                        { dynamicMenu.Add(new MenuItem(controller)); }
                    }
                }
            }
        }
        catch { }   // Most role providers can throw exceptions. Insert Log4NET or equiv here.   
        return dynamicMenu; 
    }

    public ExtController()
    {
        // Check if ControllerRolesDictionary is non-existant
        if (RolesControllerDictionary == null)
        {
            RolesControllerDictionary = new Dictionary<string, List<string>>();
            // If so, use Reflection to add List of all Roles associated with Controllers
            const bool allInherited = true;
            const string CONTROLLER = "Controller";
            var myAssembly = System.Reflection.Assembly.GetExecutingAssembly();

            // get List of all Controllers with [Authorize] attribute
            var controllerList = from type in myAssembly.GetTypes()
                                 where type.Name.Contains(CONTROLLER)
                                 where !type.IsAbstract
                                 let attribs = type.GetCustomAttributes(allInherited)
                                 where attribs.Any(x => x.GetType().Equals(typeof(AuthorizeAttribute)))
                                 select type;
            // Loop over all controllers
            foreach (var controller in controllerList)
            {   // Find first instance of [Authorize] attribute
                var attrib = controller.GetCustomAttributes(allInherited).First(x => x.GetType().Equals(typeof(AuthorizeAttribute))) as AuthorizeAttribute;
                foreach (var role in attrib.Roles.Split(',').AsEnumerable())
                {   // If there are Roles associated with [Authorize] iterate over them
                    if (!RolesControllerDictionary.ContainsKey(role))
                    { RolesControllerDictionary[role] = new List<string>(); }
                    // Add controller to List of controllers associated with role (removing "controller" from name)
                    RolesControllerDictionary[role].Add(controller.Name.Replace(CONTROLLER,""));
                }
            }
        }
    }
}

Чтобы использовать, просто:

• Добавьте [Authorize (Roles = "SomeRole1, SomeRole2, SomeRole3 и т. д."] в класс контроллеров
• Замените унаследованный «Контроллер» на «ExtController».

Например:

[Authorize(Roles = "Biologist,Admin")]
public class BiologistController : ExtController
{
    public ActionResult Index()
    { return View(); }
}

Если вы не замените «Контроллер» на «ExtController»,тогда у этого Контроллера не будет динамического меню. (Это может быть полезно, в некоторых сценариях, я думаю ...)

В моем файле Site.Master я изменил раздел "меню" , чтобы выглядеть так:

<ul id="menu">              
    <li><%= Html.ActionLink("Home", "Index", "Home")%></li>
    <%  if (ViewData.Keys.Contains("Menu"))
        {
          foreach (MenuItem menu in (IEnumerable<MenuItem>)ViewData["Menu"])
          { %>
    <li><%= Html.ActionLink(menu.Text, "Index", menu.Text)%></li>           
     <%   } 
        }   
     %>       
    <li><%= Html.ActionLink("About", "About", "Home")%></li>
</ul>

И это все!: -)

Answer 2

Я предпочитаю ссылаться на все в моих меню и создаю HtmlHelper, который проверяет, доступна ли ссылка на основе атрибутов [Authorize].

Answer 3

Я столкнулся с той же проблемой, которая требует, чтобы логика оставалась на стороне контроллера. Но мне нравится подход Джона, поскольку он использует системный фильтр, чтобы решить, авторизовано ли действие. В случае, если это кому-нибудь поможет, следующий код удалил HtmlHelper из подхода Джона:

    protected bool HasActionPermission(string actionName, string controllerName)
    {
        if (string.IsNullOrWhiteSpace(controllerName))
            return false;

        var controller = GetControllerByName(ControllerContext.RequestContext, controllerName);
        var controllerDescriptor = new ReflectedControllerDescriptor(controller.GetType());
        var actionDescriptor = controllerDescriptor.FindAction(ControllerContext, actionName);
        return ActionIsAuthorized(ControllerContext, actionDescriptor);
    }

    private static bool ActionIsAuthorized(ControllerContext controllerContext, ActionDescriptor actionDescriptor)
    {
        if (actionDescriptor == null)
            return false; // action does not exist so say yes - should we authorise this?!

        AuthorizationContext authContext = new AuthorizationContext(controllerContext, actionDescriptor);

        // run each auth filter until on fails
        // performance could be improved by some caching
        foreach (var filter in FilterProviders.Providers.GetFilters(controllerContext, actionDescriptor))
        {
            var authFilter = filter.Instance as IAuthorizationFilter;

            if (authFilter == null)
                continue;

            authFilter.OnAuthorization(authContext);

            if (authContext.Result != null)
                return false;
        }

        return true;
    }

    private static ControllerBase GetControllerByName(RequestContext context, string controllerName)
    {
        IControllerFactory factory = ControllerBuilder.Current.GetControllerFactory();

        IController controller = factory.CreateController(context, controllerName);

        if (controller == null)
        {
            throw new InvalidOperationException(

                String.Format(
                    CultureInfo.CurrentUICulture,
                    "Controller factory {0} controller {1} returned null",
                    factory.GetType(),
                    controllerName));
        }
        return (ControllerBase)controller;
    }