Jump to content
adrian

Admin Restrict Branch

Recommended Posts

I'm not sure whether it's relating to having this module installed or Lister/ListerPro by @ryan but I seem to be having issues displaying unpublished pages in Lister/ListerPro, and Ryan did mention to check on any other modules that modify permissions.

Is anyone else using this with custom Listers or ListerPro? If so, are users able to view their own unpublished pages OK?

Share this post


Link to post
Share on other sites

@Kiwi Chris - even on a site without this module installed, I have to do this for users to see unpublished pages in ListerPro:

image.thumb.png.75cf4e2b5bb977753c2745b05a0763e3.png

Does that help?

Share this post


Link to post
Share on other sites

@adrian I already have that option configured. In lister I get a message: 

Quote

Not all specified templates are editable. Only 'include=hidden' is allowed

I know this issue has come up before, and Ryan has asked people to check if they have anything that is hooking permissions.

With my site structure I have multiple clients who are restricted to what they can edit via this module, however they all have pages they can edit using common templates, so there will be some pages using a given template a user can edit and others they can't.

The template in question in my lister definitely is editable for the user, and published pages for the user show up fine.

I think AdminRestrictBranch is the only module I have installed that does hook permissions, so I thought it would be worth checking whether other people are using it and Lister/ListerPro together successfully. 

Share this post


Link to post
Share on other sites
4 hours ago, Kiwi Chris said:

Not all specified templates are editable. Only 'include=hidden' is allowed

I see that notice with non-superusers even without this module installed. Have you tested with the module uninstalled, disabled, or with a user with no restricted branches?

Share this post


Link to post
Share on other sites

@Kiwi Chris

Just looked at one of my sites and this is what I put in ready.php

// lets non superusers view unpublished and hidden pages in listers
// https://processwire.com/talk/topic/9346-not-all-specified-templates-are-editable-only-includehidden-is-allowed/?do=findComment&comment=143068
$this->wire()->addHookBefore('ProcessPageLister::getSelector', function($event) {
    $event->object->allowIncludeAll = true;
});

Does this solve your problems?

  • Like 1

Share this post


Link to post
Share on other sites
4 hours ago, adrian said:

@Kiwi Chris

Just looked at one of my sites and this is what I put in ready.php


// lets non superusers view unpublished and hidden pages in listers
// https://processwire.com/talk/topic/9346-not-all-specified-templates-are-editable-only-includehidden-is-allowed/?do=findComment&comment=143068
$this->wire()->addHookBefore('ProcessPageLister::getSelector', function($event) {
    $event->object->allowIncludeAll = true;
});

Does this solve your problems?

Thanks. This provided the result I needed. I actually added it to a custom module that added the hook, but same result.

  • Like 1

Share this post


Link to post
Share on other sites
5 hours ago, Kiwi Chris said:

Thanks. This provided the result I needed. I actually added it to a custom module that added the hook, but same result.

So just to confirm, do you agree that this module isn't having any impacts on the issue?

Share this post


Link to post
Share on other sites
4 hours ago, adrian said:

So just to confirm, do you agree that this module isn't having any impacts on the issue?

Yes, I've now also confirmed on a site that doesn't have this module installed. I'll go back to @ryan and ask him about ListerPro. It has an option to include hidden + unpublished but doesn't actually do anything. Thanks for the workaround. If I get ListerPro working as expected without this module without needing a workaround, I'll recheck again with this module to confirm it has no side effects.

Share this post


Link to post
Share on other sites
3 minutes ago, Kiwi Chris said:

I'll go back to @ryan and ask him about ListerPro. It has an option to include hidden + unpublished but doesn't actually do anything.

Did you read this thread? 

 

Share this post


Link to post
Share on other sites
On 11/7/2019 at 8:28 AM, Kiwi Chris said:

Yes, I've now also confirmed on a site that doesn't have this module installed. I'll go back to @ryan and ask him about ListerPro. It has an option to include hidden + unpublished but doesn't actually do anything. Thanks for the workaround. If I get ListerPro working as expected without this module without needing a workaround, I'll recheck again with this module to confirm it has no side effects.

I've done some further investigation, and on a site without this module, Lister/Lister Pro will show hidden + unpublished as long as the template itself has access control set.

It won't work if only the parent has access control set. Access control must be explicitly set on the template in question, as Lister (Pro) doesn't appear to look at access control inheritance.

With AdminRestrictBranch installed, even if a template does have explicit access control, and no other modifications to access control, it does seem that the hidden + unpublished option in Lister/Lister Pro doesn't work, although using the include all hook, or doing the equivalent creating the lister via the API, setting allowIncludeAll property to true, and including include=all in initSelector property of the lister does provides provides the expected results.

Share this post


Link to post
Share on other sites
2 hours ago, Kiwi Chris said:

Lister/Lister Pro will show hidden + unpublished as long as the template itself has access control set.

I see that too but it's weird to me that access permissions aren't inherited from the home template in this case. Why should we have to explicitly set permissions for the specific template for this to work? Do you agree or am I missing something?

2 hours ago, Kiwi Chris said:

With AdminRestrictBranch installed, even if a template does have explicit access control, and no other modifications to access control, it does seem that the hidden + unpublished option in Lister/Lister Pro doesn't work

Thanks, I can also confirm this - will see if it's fixable.

Share this post


Link to post
Share on other sites

Ok, so I found the source of the problem: https://github.com/processwire/processwire/blob/4e4b3afdcbe9aef27d03170dab64dc6e8e6c5a4d/wire/modules/Process/ProcessPageLister/ProcessPageLister.module#L1100-L1106

Lister (the base version in the core) checks to see if a test page is editable but it doesn't ever set the parent:

// determine how many templates are editable
$test = $this->wire('pages')->newPage();
foreach($templates as $template) {
    $test->template = $template;
    $test->id = 999; // required (any ID number works)
    if($test->editable()) $numEditable++;
}

Without knowing the parent, when AdminRestrictBranch hooks into editable() it has to return false. If you want to test this out, add:

$test->parent = xxxx;

where xxxx is the ID of the branch parent you are restricting to - with that in place, you won't need the ProcessPageLister::getSelector hook.

I feel like that code in Lister is a bit hacky and will cause problems with lots of modules that hook into editable(). 

I am not sure this is a good way for me to workaround this. Perhaps I could have an option in AdminRestrictBranch to automatically add this hook:

$this->wire()->addHookBefore('ProcessPageLister::getSelector', function($event) {
    $event->object->allowIncludeAll = true;
});

rather than having to add it manually.

But I still think it's really weird that for Lister to work as expected you can't rely on inherited template edit permissions in the first place. Although this reason for this is obviously the lack of parent for the $test page - it can't rely on inherited permissions because it doesn't have a template to inherit from.

Share this post


Link to post
Share on other sites

Hi Adrian,

we use your excellent module for a customer, who wants restrict access to users in exactly that way, that your module gives (by role name). Now, they want to let some users act for more than one role name. This seems to be possible by activating the desired roles in user settings, but isn't working. I.e., the user always has access to the branch of the first limiting role, but not to further one(s). 

So, it looks like it ist not possible to combine two ore more restricted roles for one user?

Greeting, Thomas.

Share this post


Link to post
Share on other sites

@xportde - hi Thomas.

Unfortunately with the way this module is built, it can only ever work for one branch.

There are other ways to achieve what you are looking for - this thread (https://processwire.com/talk/topic/1176-hiding-uneditable-pages-from-users/) contains lots of useful info, but keep in mind there are lots of hooks you'll need to implement to ensure everything is locked down - it's one thing to hide part of the page tree, but you also need to hide the pages from the top-level nav under Pages > Tree. You also need to prevent direct edit access to pages outside the allowed branches. You may also want to consider modifying the breadcrumbs (like this module allows). 

Honestly I think it's a shame that the core doesn't support this natively.

 

Share this post


Link to post
Share on other sites

Hi Adrian,

thanks for clearing this out! No problem, if your module is intended for restricting to one branch, then we will suggest our client to use it that way.

Greeting, Thomas.

  • Like 1

Share this post


Link to post
Share on other sites

Will the custom PHP code option work with multiple statements? I have a tree structure like:
Members
-Member 1
 -page 1
 -page 2
-Member 2
Competitions
...

I want to restrict logins with role member to just their own member branch, and that works fine currently with: return "/members/" . ($user->name);

What I'd like to do is if a login has the role 'membership-secretary' set their branch to Members, and then any other admin roles to home, as I can use template permissions to prevent them accessing parts of the site they shouldn't, but I'm trying to make it easier on the 'membership-secretary' role so they only have to see the branch of tree they'll work with.

I understand the module doesn't support restricting to multiple branches simultaneously, but I don't think that's what I'm trying to do. I only want to grant access to a single branch to a given user, however depending on their role, they will have access at a different level in the page tree.

I had a go with 

if($user->hasRole('competition-secretary') || $user->hasRole('membership-secretary'){return "/members/";}else if($user->hasRole('member'){return "/members/" . ($user->name);}else{return "/"}

statement, but that caused a 500 error, so I'm just checking whether this kind of use case scenario is possible?

 

Share this post


Link to post
Share on other sites

I think that should work, but your if statements are missing the closing ")"

You have:

if($user->hasRole('competition-secretary') || $user->hasRole('membership-secretary') {
    return "/members/";
}
else if($user->hasRole('member') {
    return "/members/" . ($user->name);
}
else {
    return "/"
}

instead of:

if($user->hasRole('competition-secretary') || $user->hasRole('membership-secretary')) {
    return "/members/";
}
else if($user->hasRole('member')) {
    return "/members/" . ($user->name);
}
else {
    return "/"
}

The error should go away if you fix the syntax.

I think you might also need a closing slash after $user->name to complete the path.

  • Like 1

Share this post


Link to post
Share on other sites

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now

  • Recently Browsing   0 members

    No registered users viewing this page.

  • Similar Content

    • By bernhard
      --- Please use RockFinder3 ---
    • By MoritzLost
      Cacheable Placeholders
      This module allows you to have pieces of dynamic content inside cached output. This aims to solve the common problem of having a mostly cacheable site, but with pieces of dynamic output here and there.  Consider this simple example, where you want to output a custom greeting to the current user:
      <h1>Good morning, <?= ucfirst($user->name) ?></h1> This snippet means you can't use the template cache (at least for logged-in users), because each user has a different name. Even if 99% of your output is static, you can only cache the pieces that you know won't include this personal greeting. A more common example would be CSRF tokens for HTML forms - those need to be unique by definition, so you can't cache the form wholesale.
      This module solves this problem by introducing cacheable placeholders - small placeholder tokens that get replaced during every request. The replacement is done inside a Page::render hook so it runs during every request, even if the response is served from the template cache. So you can use something like this:
      <h1>Good morning, {{{greeting}}}</h1> Replacement tokens are defined with a callback function that produces the appropriate output and added to the module through a simple hook:
      // site/ready.php wire()->addHookAfter('CachePlaceholders::getTokens', function (HookEvent $e) { $tokens = $e->return; $tokens['greeting'] = [ 'callback' => function (array $tokenData) { return ucfirst(wire('user')->name); } ]; $e->return = $tokens; }); Tokens can also include parameters that are parsed and passed to the callback function. There are more fully annotated examples and step-by-step instructions in the README on Github!
      Features
      A simple and fast token parser that calls the appropriate callback and runs automatically. Tokens may include multiple named or positional parameters, as well as multi-value parameters. A manual mode that allows you to replace tokens in custom pieces of cached content (useful if you're using the $cache API). Some built-in tokens for common use-cases: CSRF-Tokens, replacing values from superglobals and producing random hexadecimal strings. The token format is completely customizable, all delimiters can be changed to avoid collisions with existing tag parsers or template languages. Links
      Github Repository & documentation Module directory (pending approval) If you are interested in learning more, the README is very extensive, with more usage examples, code samples and usage instructions!
    • By Craig
      I've been using Fathom Analytics for a while now and on a growing number of sites, so thought it was about time there was a PW module for it.
      WayFathomAnalytics
      WayFathomAnalytics is a group of modules which will allow you to view your Fathom Analytics dashboard in the PW admin panel and (optionally) automatically add and configure the tracking code on front-end pages.
      Links
      GitHub Readme & documentation Download Zip Modules directory Module settings screenshot What is Fathom Analytics?
      Fathom Analytics is a simple, privacy-focused website analytics tool for bloggers and businesses.

      Stop scrolling through pages of reports and collecting gobs of personal data about your visitors, both of which you probably don't need. Fathom is a simple and private website analytics platform that lets you focus on what's important: your business.
      Privacy focused Fast-loading dashboards, all data is on a single screen Easy to get what you need, no training required Unlimited email reports Private or public dashboard sharing Cookie notices not required (it doesn't use cookies or collect personal data) Displays: top content, top referrers, top goals and more
    • By daniels
      This is a lightweight alternative to other newsletter & newsletter-subscription modules.
      You can find the Module in the Modules directory and on Github
      It can subscribe, update, unsubscribe & delete a user in a list in Mailchimp with MailChimp API 3.0. It does not provide any forms or validation, so you can feel free to use your own. To protect your users, it does not save any user data in logs or sends them to an admin.
      This module fits your needs if you...
      ...use Mailchimp as your newsletter / email-automation tool ...want to let users subscribe to your newsletter on your website ...want to use your own form, validation and messages (with or without the wire forms) ...don't want any personal user data saved in any way in your ProcessWire environment (cf. EU data regulation terms) ...like to subscribe, update, unsubscribe or delete users to/from different lists ...like the Mailchimp UI for creating / sending / reviewing email campaigns *I have only tested it with PHP 7.x so far, so use on owners risk
      EDIT:
      Since 0.0.4, instructions and changelog can be found in the README only. You can find it here  🙂
      If you have questions or like to contribute, just post a reply or create an issue or pr on github, thanks!
    • By MoritzLost
      Sorry for the convoluted title. I have a problem with Process modules that define a custom page using the page key through getModuleInfo (as demonstrated in this excellent tutorial by @bernhard). Those pages are created automatically when the module is installed. The problem is that the title of the page only gets set in the current language. That's not a problem if the current language (language of the superuser who is installing the module) is the default language; if it isn't, the Process page is missing a title in the default language. This has the very awkward effect that a user using the backend in the default language (or any other language) will see an empty entry in the setup menu:

      This screenshot comes from my Cache Control module which includes a Process page. Now I realize the description sounds obscure, but for us it's a common setup: We a multiple bilingual sites where the default language is German and the second language is English. While the clients use the CMS in German, as a developer I prefer the English interface, so whenever I install a Process module I get this problem.
      As a module author, is there a way to handle this situation? I guess it would be possible to use post-installation hooks or create the pages manually, but I very much prefer the declarative approach. The page title is already translatable (through the __ function), but of course at the time of installation there is no translation, and as far as I'm aware it's not possible to ship translations with a module so they are used automatically. Could this situation be handled better in the core? I would prefer if the module installation process would always set the title of the Process page in the default language, instead of the language of the current user.
×
×
  • Create New...