adrian

Page Protector

Recommended Posts

Thanks - I couldn't get the $ppid variable either (similarly to $loginForm). Anyway, I think it's not that important, I can get the protected parent manually too and get content from it (even multilanguage).

It took some time I understood the module's workings but finally it's up and running the way I wanted, thanks for the help! :) 

Share this post


Link to post
Share on other sites
4 minutes ago, tpr said:

It took some time I understood the module's workings but finally it's up and running the way I wanted, thanks for the help! :) 

No problem!

Should I commit the version with $page->protected property then? I assume that is still something you need to get it working in your scenario?

Share this post


Link to post
Share on other sites

Sure, that will come handy, thanks!

  • Like 1

Share this post


Link to post
Share on other sites

Hello.

First off all, thanks for that great module. 

My problem is the combination of the TemplateEngineFactory module and the PageProtector module. Both modules don't work together.

The problem is the Page::render, unfortunately both modules define a after hook. The TemplateEngineFactory always overwrites the PageProtector hook. 

[Page::render] => Array
(
    [0] => PageRender->renderPage() in PageRender.module
    [1] => PageProtector->protectedCheck() in PageProtector.module
    [2] => TemplateEngineFactory->hookRender() in TemplateEngineFactory.module.php
)

When I remove the TemplateEngineFactory module everything works correctly and the login page is displayed. If both modules are acitve the login page ist not displayed. 

Can someone help me? Both modules should work together...

Thanks!

Share this post


Link to post
Share on other sites

Hi @wbertl - firstly, welcome to the forums!

Please upgrade to the latest version which should fix the issue for you.

  • Like 1

Share this post


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

Hi @wbertl - firstly, welcome to the forums!

Please upgrade to the latest version which should fix the issue for you.

Hey adrian,

many thanks. It works now!

  • Like 1

Share this post


Link to post
Share on other sites

Howdy @adrian

I'm wondering why I get lots of "Saved module 'PageProtector' config data" entries in /site/assets/logs/modules.txt as I do not remember saving the module settings so frequently. If it is not my "fault", can you please take a look at how to "get rid of them" should they be generated "by mistake".

  • Like 1

Share this post


Link to post
Share on other sites
17 hours ago, szabesz said:

Howdy @adrian

I'm wondering why I get lots of "Saved module 'PageProtector' config data" entries in /site/assets/logs/modules.txt as I do not remember saving the module settings so frequently. If it is not my "fault", can you please take a look at how to "get rid of them" should they be generated "by mistake".

Thanks for noticing that - it should be fixed in the latest version.

Because there are settings for this module on every page (Settings tab), saving the page was saving the settings. Now I check to see if there are any changes before saving.

Please let me know if it works as expected for you.

  • Like 1

Share this post


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

it should be fixed in the latest version

Thanx a lot! I will update the site in question – and all its modules – on the weekend, and report back.

Share this post


Link to post
Share on other sites

Hi Everyone,

I was wondering if anyone can help me with a problem I'm having.

I'm currently using the Intermediate templating schema which you can choose from when first developing PW on localhost. 

Firstly, let me say this is a great module and thank you for developing it.

Secondly, to the problem, I'm trying to render login form via "$content .= loginForm;" however that doesn't appear to work and produces nothing but a blank page.

The only way the login form shows is without the _main.php layout by using the default "echo loginForm;" approach.

 

Share this post


Link to post
Share on other sites

Is the missing $ in your post a typo here in the forum?

You need:

$content .= $loginForm;

Also, it depends on how your _main.php is set up. Is $content the final variable that is echo'd at the end, or is it $out or something else? Of course you need to use the variable that is actually used in your _main.php file. $content is just an example.

  • Like 1

Share this post


Link to post
Share on other sites
29 minutes ago, adrian said:

Is the missing $ in your post a typo here in the forum?

 

yes that's a typo in the forum.
 

 

29 minutes ago, adrian said:

Also, it depends on how your _main.php is set up. Is $content the final variable that is echo'd at the end, or is it $out or something else? Of course you need to use the variable that is actually used in your _main.php file. $content is just an example.

Yes, $content is the main output variable coming from the _main.php file.

My loginForm template page works if i use :

<?php namespace ProcessWire;

echo $loginForm;

shows blank screen using:

<?php namespace ProcessWire;

$content = $loginForm;

Maybe i'm missing something simple...

Share this post


Link to post
Share on other sites
33 minutes ago, JasonS said:

Maybe i'm missing something simple...

I think we'd need to see your files to help any further.

Does populating $content with anything else actually get output on the end?

Share this post


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

Does populating $content with anything else actually get output on the end?

No, That's the confusing part. 

loginform.php

<?php namespace ProcessWire;

echo $loginForm;

_main.php
 

<?php namespace ProcessWire;

/**
 * _main.php
 * Main markup file
 *
 * This file contains all the main markup for the site and outputs the regions 
 * defined in the initialization (_init.php) file. These regions include: 
 * 
 *   $title: The page title/headline 
 *   $content: The markup that appears in the main content/body copy column
 *   $sidebar: The markup that appears in the sidebar column
 * 
 * Of course, you can add as many regions as you like, or choose not to use
 * them at all! This _init.php > [template].php > _main.php scheme is just
 * the methodology we chose to use in this particular site profile, and as you
 * dig deeper, you'll find many others ways to do the same thing. 
 * 
 * This file is automatically appended to all template files as a result of 
 * $config->appendTemplateFile = '_main.php'; in /site/config.php. 
 *
 * In any given template file, if you do not want this main markup file 
 * included, go in your admin to Setup > Templates > [some-template] > and 
 * click on the "Files" tab. Check the box to "Disable automatic append of
 * file _main.php". You would do this if you wanted to echo markup directly 
 * from your template file or if you were using a template file for some other
 * kind of output like an RSS feed or sitemap.xml, for example. 
 *
 * See the README.txt file for more information. 
 *
 */
?><!DOCTYPE html>
<html lang="en">
<head>
	<meta http-equiv="content-type" content="text/html; charset=utf-8" />
	<meta name="viewport" content="width=device-width, initial-scale=1" />
	<title><?php echo $title; ?></title>
	<meta name="description" content="<?php echo $page->summary; ?>" />
	<link href='//fonts.googleapis.com/css?family=Lusitana:400,700|Quattrocento:400,700' rel='stylesheet' type='text/css' />
	<link rel="stylesheet" type="text/css" href="<?php echo $config->urls->templates?>styles/main.css" />
</head>
<body class="<?php if($sidebar) echo "has-sidebar "; ?>">

	<a href="#main" class="visually-hidden element-focusable bypass-to-main">Skip to content</a>

<h1 align="center" class="logo-text">
      <a href="<?php echo $config->urls->root ?>" class="logo-link"><?php $page->sitename ?></a>
    </h1>

	<!-- top navigation -->
	<ul class='topnav' role='navigation'><?php
		// top navigation consists of homepage and its visible children
		foreach($homepage->and($homepage->children) as $item) {
			if($item->id == $page->rootParent->id) {
				echo "<li class='current' aria-current='true'><span class='visually-hidden'>Current page: </span>";
			} else {
				echo "<li>";
			}
			echo "<a href='$item->url'>$item->title</a></li>";
		}

		// output an "Edit" link if this page happens to be editable by the current user
		if($page->editable()) echo "<li class='edit'><a href='$page->editUrl'>Edit</a></li>";
	?></ul>

	<!-- search form
	<form class='search' action='<?php echo $pages->get('template=search')->url; ?>' method='get'>
		<label for='search' class='visually-hidden'>Search:</label>
		<input type='text' name='q' placeholder='Search' id='search' value='<?php echo $sanitizer->entities($input->whitelist('q')); ?>' />
		<button type='submit' name='submit' class='visually-hidden'>Search</button>
	</form>-->

	<!-- breadcrumbs -->
	<div class='breadcrumbs' role='navigation' aria-label='You are here:'><?php
		// breadcrumbs are the current page's parents
		//foreach($page->parents() as $item) {
			//echo "<span><a href='$item->url'>$item->title</a></span> "; 
		//}
		// optionally output the current page as the last item
		//echo "<span>$page->title</span> "; 
	?></div>

	<div id='main'>

		<!-- main content -->
		<div id='content'>
			<h1 align="center"><?php echo $title; ?></h1>
			<?php echo $content; ?>
		</div>

		<!-- sidebar content -->
		<?php if($sidebar): ?>
		<aside id='sidebar'>
			<?php echo $sidebar; ?>
		</aside>
		<?php endif; ?>

	</div>

	<!-- footer -->
	<footer id='footer'>
		<p>
		Powered by <a href='http://processwire.com'>ProcessWire CMS</a>  &nbsp; / &nbsp; 
		<?php 
		if($user->isLoggedin()) {
			// if user is logged in, show a logout link
			echo "<a href='{$config->urls->admin}login/logout/'>Logout ($user->name)</a>";
		} else {
			// if user not logged in, show a login link
			echo "<a href='{$config->urls->admin}'>Admin Login</a>";
		}
		?>
		</p>
	</footer>
	<script   src="https://code.jquery.com/jquery-3.2.1.min.js"   integrity="sha256-hwg4gsxgFZhOsEEamdOYGBf13FyQuiTwlAQgxVSNgt4="   crossorigin="anonymous"></script>
	<script>
	$('img').bind('contextmenu', function(e) {
    return false;
}); 
</script>

</body>
</html>

 

Share this post


Link to post
Share on other sites

Ok, I think the problem is that loginform.php needs to be:

$content = $loginForm;

which I think you have already tried, but just not in the code you just posted.

Also, is loginform.php selected in the module settings for the "Login Template" setting?

Also, because loginform.php is not an actual PW template, _main.php won't be automatically included, so you will need to manually add:

require_once '_main.php';

after you define $content, so this should do it:

<?php namespace ProcessWire;

echo $content = $loginForm;
require_once '_main.php';

 

Share this post


Link to post
Share on other sites
1 hour ago, adrian said:

which I think you have already tried, but just not in the code you just posted.

yes i did. Didn't work.

1 hour ago, adrian said:

Also, is loginform.php selected in the module settings for the "Login Template" setting?

 

Yes, it is.
 

1 hour ago, adrian said:

<?php namespace ProcessWire; echo $content = $loginForm; require_once '_main.php';

I applied your code and doesn't work. I'll attach a screenshot of what I see.


 

Screenshot at Nov 04 22-20-23.png

Share this post


Link to post
Share on other sites

Sorry, my fault - you don't want to echo $content in loginform.php - you just want to set it - it needs to be echo'd in main.php if you want the login form to appear with your site html wrapper content.

Is this site online somewhere I could take a look?

Share this post


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

Is this site online somewhere I could take a look?

Unfortunately, no it isn't. Local webdev development on my machine.

Share this post


Link to post
Share on other sites

Hi adrian,
very usefull - thank you!!
Is it possible to have "allowed users" additionally to "Allowed Roles"?
I would like to give a specific user access to one specific page. With a role-access i couldn´t achieve that, because then many of the users with this role would have access to this page - and this is not desired.

Share this post


Link to post
Share on other sites
On 1/5/2018 at 8:15 AM, itsberni said:

Hi adrian,
very usefull - thank you!!
Is it possible to have "allowed users" additionally to "Allowed Roles"?
I would like to give a specific user access to one specific page. With a role-access i couldn´t achieve that, because then many of the users with this role would have access to this page - and this is not desired.

Hi @itsberni - I certainly could add it, but on sites with a lot of users, the interface for selecting allowed users would need careful attention.

Is there any reason you couldn't add a new custom role to just the specific user and use that role to provide access?

Share this post


Link to post
Share on other sites

Hi adrian!

i Could do that, of course. But i thought it would be easier to assign a spezific Page to a user.

i solved it now with a different approach. 

I added a page reference field to the User Template. In the template.php i check for the User and simultaneously if the visited page = the referenced page in the users entry. That works for me. nevertheless thank you!

  • Like 1

Share this post


Link to post
Share on other sites

HI @adrian,

I would like to try your PageProtector module but I have to know whether I can set the login (username-password pair) per page? If I understand it correctly, the username-password pair can be set globally and not for every single page.

Share this post


Link to post
Share on other sites
3 hours ago, LAPS said:

HI @adrian,

I would like to try your PageProtector module but I have to know whether I can set the login (username-password pair) per page? If I understand it correctly, the username-password pair can be set globally and not for every single page.

Each page can be restricted to a user role, so you could setup each page to be limited to a different role and assign these roles to separate users - I think this would give you what you want. But without knowing exactly your scenario, it's hard to know if this would be the best option or not. You might be better off with a custom module or a ready.php hook on Page::render and handle the logic that way.

image.png.2615acd8e2417d380aa768e522163254.png

  • Like 1

Share this post


Link to post
Share on other sites
On 5.11.2017 at 3:10 AM, adrian said:

Ok, I think the problem is that loginform.php needs to be:


$content = $loginForm;

which I think you have already tried, but just not in the code you just posted.

Also, is loginform.php selected in the module settings for the "Login Template" setting?

Also, because loginform.php is not an actual PW template, _main.php won't be automatically included, so you will need to manually add:


require_once '_main.php';

after you define $content, so this should do it:


<?php namespace ProcessWire;

echo $content = $loginForm;
require_once '_main.php';

 

I tried this too, but it seems to me the intermediate templating doesn't work with this module having defined my own login-page. I get errors pointing to undefined variables that are defined in _init.php. If I try to require the _init.php first, then add $loginForm to $content and then require_once _main.php, I get other errors that result from login.php template not being a PW template:

Class 'FilenameArray' not found in site/templates/_init.php

Have you really used login.php template with intermediate templating?

 

Share this post


Link to post
Share on other sites
On 1/27/2018 at 8:11 AM, lpa said:

Have you really used login.php template with intermediate templating?

Hi @lpa - sorry you're having trouble with this approach. I have definitely used it before with the "intermediate" approach, but it turns out I was doing things a little different in terms of how files were being prepended. I just tried with the regular intermediate templating approach and I could reproduce the errors you were seeing.

I have a fix in place for you though.

My login.php template file looks like this.

<?php
$content = $page->loginForm;
include '_main.php';

Obviously you can use whatever *.php file you want - selected from the module settings.

The key difference now is that you must use: $page->loginForm and not $loginForm

Please test the attached version (I don't want to commit just yet) and let me know how you go.

 

PageProtector.zip

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 dreerr
      TemplateEnginePug (formally TemplateEngineJade)
       
      This module adds Pug templates to the TemplateEngineFactory. It uses https://github.com/pug-php/pug to render templates.
      doctype html html(lang='en') head meta(http-equiv='content-type', content='text/html; charset=utf-8') title= $page->title link(rel='stylesheet', type='text/css', href=$config->urls->templates . 'styles/main.css') body include header.pug h1= $page->title if $page->editable() p: a(href=$page->editURL) Edit Project on GitHub: github.com/dreerr/TemplateEnginePug
      Project in modules directory: modules.processwire.com/modules/template-engine-pug/
       
      For common problems/features/questions about the Factory, use the TemplateEngineFactory thread.
       
    • By tpr
      ProcessNetteTester
      Run Nette Tester tests within ProcessWire admin.
      (continued from here)

      Features
      AJAX interface for running Nette Tester tests, in bulk or manually display counter, error message and execution time in a table run all tests at once or launch single tests show formatted test error messages and report PHP syntax errors stop on first failed test (optional) hide passed tests (optional) display failed/total instead passed/total (optional) re-run failed tests only (optional) auto scroll (optional) include or exclude tests based on query parameters start/stop all tests with the spacebar reset one test or all tests (ctrl+click) https://modules.processwire.com/modules/process-nette-tester/
      https://github.com/rolandtoth/ProcessNetteTester
    • By bernhard
      Some of you might have followed the development of this module here: https://processwire.com/talk/topic/15524-previewdiscussion-rockdatatables/ . It is the successor of "RockDataTables" and requires RockFinder to get the data for the grid easily and efficiently. It uses the open source part of agGrid for grid rendering.
       
      WHY?
      ProcessWire is awesome for creating all kinds of custom backend applications, but where it is not so awesome in my opinion is when it comes to listing this data. Of course we have the built in page lister and we have ListerPro, but none of that solutions is capable of properly displaying large amounts of data, for example lists of revenues, aggregations, quick and easy sorts by the user, instant filter and those kind of features. RockGrid to the rescue 😉 
       
      Features/Highlights:
      100k+ rows Instant (client side) filter, search, sort (different sort based on data type, eg "lower/greater than" for numbers, "contains" for strings) extendable via plugins (available plugins at the moment: fullscreen, csv export, reload, batch-processing of data, column sum/statistics, row selection) all the agGrid features (cell renderers, cell styling, pagination, column grouping etc) vanilla javascript, backend and frontend support (though not all plugins are working on the frontend yet and I don't plan to support it as long as I don't need it myself)  
      Limitations:
      While there is an option to retrieve data via AJAX the actual processing of the grid (displaying, filtering, sorting) is done on the client side, meaning that you can get into troubles when handling really large datasets of several thousands of rows. agGrid should be one of the most performant grid options in the world (see the official example page with a 100k row example) and does a lot to prevent problems (such as virtual row rendering), but you should always have this limitation in mind as this is a major difference to the available lister options that do not have this limitation.
      Currently it only supports AdminThemeUikit and I don't plan to support any other admin theme.
       
      Download: https://gitlab.com/baumrock/RockGrid
      Installation: https://gitlab.com/baumrock/RockGrid/wikis/Installation
      Quikckstart: https://gitlab.com/baumrock/RockGrid/wikis/quickstart
      Further instructions: https://gitlab.com/baumrock/RockGrid/wikis/quickstart#further-instructions
       
      Module status: alpha, License: MIT
      Note that every installation and uninstallation sends an anonymous google analytics event to my google analytics account. If you don't want that feel free to remove the appropriate lines of code before installation/uninstallation.
       
      Contribute:
      You can contribute to the development of this and other modules or just say thank you by
      testing, reporting issues and making PRs at gitlab liking this post buying me a drink: paypal.me/baumrock/5 liking my facebook page: facebook.com/baumrock hiring me for pw work: baumrock.com  
      Support: Please note that this module might not be as easy and plug&play as many other modules. It needs a good understanding of agGrid (and JavaScript in general) and it likely needs some looks into the code to get all the options. Please understand that I can not provide free support for every request here in the forum. I try to answer all questions that might also help others or that might improve the module but for individual requests I offer paid support for 60€ per hour.
       
      Changelog
      180711 bugfix (naming issue) 180630 alpha realease  
      Use Cases / Examples:
      Colored grid cells, Icons, Links etc. The Grid also has a "batcher" feature built in that helps communicating with the server via AJAX and managing resource intensive tasks in batches:

      Filters, PW panel links and instant reload on panel close:

      You can combine the grid with a chart library like I did with the (outdated) RockDataTables module:

    • By tpr
      Update 2018-07-09: ProcessNetteTester module is available in the Modules Directory and on GitHub.

      This is a short tutorial on how to use Nette Tester with ProcessWire.
      As you will see it's very easy to setup and use and it's perfect for testing your code's functionality. With bootstrapping ProcessWire it's also possible to check the rendered markup of pages using the API, checking page properties, etc. It's also a great tool for module developers for writing better code. 
      While there will be nothing extraordinary here that you couldn't find in Tester's docs this can serve as a good starting point.
      Prerequisites: PHP 5.6+
      01 Download Tester
      Go to https://github.com/nette/tester/releases and download the latest release (currently 2.0.2). Download from the link reading "Source code (zip)". You can use composer also if you wish.
      02 Extract Tester files
      Create a new directory in your site root called "tester". Extract the zip downloaded here, so it should look like this:
      /site /tester/src /tester/tools /tester/appveyor.yml /tester/composer.json /tester/contributing.md /tester/license.md /tester/readme.md /wire ... 03 Create directory for test files
      Add a new directory in "/tester" called "tests". Tester recognizes "*.Test.php" and "*.phpt" files in the tests directory, recursively. 
      04 Create your first test
      In the "tests" directory create a new "MyTest.php" file.
      The first test is a very simple one that bootstraps ProcessWire and checks if the Home page name is "Home". This is not the smartest test but will show you the basics.
      Add this to "/tester/tests/MyTest.php":
      <?php namespace ProcessWire; use \Tester\Assert; use \Tester\DomQuery; use \Tester\TestCase; use \Tester\Environment; require __DIR__ . '/../src/bootstrap.php'; // load Tester require __DIR__ . '/../../index.php'; // bootstrap ProcessWire Environment::setup(); class MyTest extends TestCase {     // first test (step 04)     public function testHomeTitle()     {         $expected = 'Home'; // we expect the page title to be "Home"         $actual = wire('pages')->get(1)->title; // check what's the actual title Assert::equal($expected, $actual); // check whether they are equal     }     // second test will go here (step 06)     // third test will go here (step 07) } // run testing methods (new MyTest())->run(); I've added comment placeholders for the second and third tests that we will insert later.
      05 Run Tester
      Tester can be run either from the command line or from the browser. The command line output is more verbose and colored while in the browser it's plain text only (see later).
      Running from the command line
      Navigate to the "/tester" directory in your console and execute this:
      php src/tester.php -C tests This will start "/tester/src/tester.php" and runs test files from the "/tester/tests" directory. The "-C" switch tells Tester to use the system-wide php ini file, that is required here because when bootstrapping ProcessWire you may run into errors (no php.ini file is used by default). You may load another ini file with the "-c <path>" (check the docs).
      If the title of your Home page is "Home" you should see this:

      If it's for example "Cats and Dogs", you should see this:

      Running from the browser
      First we need to create a new PHP file in ProcessWire's root, let's call it "testrunner.php". This is because ProcessWire doesn't allow to run PHP files from its "site" directory.
      The following code runs two test classes and produces a legible output. IRL you should probably iterate through directories to get test files (eg. with glob()), and of course it's better not allow tests go out to production.
      <?php ini_set('html_errors', false); header('Content-type: text/plain'); echo 'Starting tests.' . PHP_EOL; echo '--------------------------' . PHP_EOL; $file = __DIR__ . '/PATH_TO/FirstTest.php'; echo basename($file) . ' '; require $file; echo '[OK]' . PHP_EOL; $file = __DIR__ . '/PATH_TO/SecondTest.php'; echo basename($file) . ' '; require $file; echo '[OK]' . PHP_EOL; echo '--------------------------' . PHP_EOL; echo 'Tests finished.'; exit; Navigate to "DOMAIN/testrunner.php" in your browser to execute the file. If every test succeeds you should get this:

      If there are failed tests the execution stops and you can read the error message. If there were more tests (eg. ThirdTest), those won't be displayed under the failed test.

      06 DOM test
      This test will check if a page with "basic-page" template has a "h1" element. We will create the page on the fly with ProcessWire's API. To keep things simple we will add the new test as a new method to our MyTest class.
      Add this block to the MyTest class:
      public function testBasicPageHeadline() {     $p = new Page();     $p->template = 'basic-page';     $html = $p->render();     $dom = DomQuery::fromHtml($html);     Assert::true($dom->has('h1')); } This will most likely be true but of course you can check for something more specific, for example "div#main". Note that we have used the DomQuery helper here (check the "use" statement on the top of the file).
      07 Custom function test
      You will probably want to make sure your custom functions/methods will work as they should so let's write a test that demonstrates this.
      I don't want to complicate things so I'll check if the built-in "pageName" sanitizer works as expected. Add this to the myTest class:
      public function testPageNameSanitizer() {     $expected = 'hello-world';     $actual = wire('sanitizer')->pageName('Hello world!', true);     Assert::equal($expected, $actual); } This should also be true. Try to change the expected value if you are eager to see a failure message.
       
      08 Next steps
      You can add more methods to the MyTest class or create new files in the "tests" directory. Check out the range of available Assertions and other features in the docs and see how they could help you writing more fail-safe code.
      Once you make a habit of writing tests you'll see how it can assist making your code more bulletproof and stable. Remember: test early, test often 🙂
      If you find out something useful or cool with Tester make sure to share.
    • By bernhard
      @Sergio asked about the pdf creation process in the showcase thread about my 360° feedback/survey tool and so I went ahead and set my little pdf helper module to public.
      Description from PW Weekly:
       
      Download & Docs: https://gitlab.com/baumrock/RockPdf
       
      You can combine it easily with RockReplacer: 
      See also a little showcase of the RockPdf module in this thread: