Jump to content
adrian

Protected/Development/Maintenance Mode

Recommended Posts

This is a simple module to prevent guest users and search engines from accessing to your site. Primarily it is designed for use during site development.

Modules directory: http://modules.processwire.com/modules/protected-mode/

Github: https://github.com/adrianbj/ProtectedMode

  1. Install and check the "Protected Mode" checkbox
  2. Create a user with only the guest role and give the login details to your clients/testers. Of course existing admin users can use their personal logins still.
There are some similarities with Pete's excellent Maintenance Mode module, but the reason I built this, rather than using Maintenance Mode is:
  • I didn't want the "Maintenance Mode" badge showing up on the site since this is for development before a site has ever been live and I didn't want the client seeing that badge.
     
  • I didn't want users redirected to the PW login page because I didn't want visitors to see the PW login page. I know the module has the option to redirect to a custom page, which you could use to make a front-end login form, but that seemed more complex than I needed (and I think other PW devs might also need).
     
  • Because of the way this module replaces Page::render with the login form, visitors can be sent to any page on the site, and once they login that page will reload with its full content - no messing around finding the page again, and no need for sending page ids through the login process to redirect back.
     
  • This module also lets you configure the message that is displayed along with the login form, and also apply some css to style the login form.
 
Hope you guys find it useful.
  • Like 20

Share this post


Link to post
Share on other sites

Just a small update that adds some nice default styling to the login form. It populates the CSS field on install so you can still edit however you want, but gives a much nicer starting point :)

If you have the module already installed, you'll want to update, then uninstall and reinstall to populate the CSS field.

It now looks like this by default:

post-985-0-01585300-1412483106_thumb.png

  • Like 3

Share this post


Link to post
Share on other sites

Hi everyone,

I'd like to announce a complete overhaul of this module - problem is that I am not sure whether to release it as an update to this module, or perhaps as something completely new, perhaps called PageProtector.

UPDATE: The functionality described in this post is available as a separate module: PageProtector

This new version (not on github just yet) makes it very easy for site editors to set up various password protected areas on their site, or to simply protect a new page or section while they are still working on it.

 

New functionality

  • Ability for your site editors to control the user access to pages directly from Settings tab of each page
  • Includes whether to protect all children of this page or not
  • Optionally allows access to only specified roles
  • Ability to change the message on the login page to make it specific to this page
  • Option to have login form and prohibited message injected into a custom template
  • Access to the above "Protect this Page" settings panel is controlled by the "page-edit-protected" permission
  • Table in the module config settings that lists the details all of the protected pages
  • Shortcut to protect entire site with one click
What do you all think - replace the existing module, or release this functionality as a separate version?
 
Module Config Settings
post-985-0-25827500-1414466945_thumb.png
 
Page Protection Settings
post-985-0-82241700-1414467063_thumb.png
  • Like 13

Share this post


Link to post
Share on other sites

Please fill out the poll at the top of the page to help me decide on how to release this new functionality.

Thanks!

Share this post


Link to post
Share on other sites

This looks great Adrian, not sure about which option to check as haven't used the first module. This could definitely be a module in it's own right though. Could be really useful.

Share this post


Link to post
Share on other sites

Hi Adrian,

great idea. I will try this out on my new project.

Just curious:

Isn't there a need to also sanitize the password somehow (or is PW handling that?)

Like a max-length, trim whitespaces (for user convenience)

Share this post


Link to post
Share on other sites

ceberlin,

Just so you know, the new enhanced version (with page specific, editor managed control) is not released just yet - I am on vacation for the next two weeks, but I plan on releasing when I am back.

The login process is still handled by PW, so need to do any additional sanitizing/cleaning.

  • Like 1

Share this post


Link to post
Share on other sites

Hi everyone,

Finally made some time to get the new module live. It is called Page Protector and you can find out more about it here:

https://processwire.com/talk/topic/8387-page-protector/

Thanks to everyone who voted in the poll - based on the results, there will be two separate modules maintained: ProtectedMode and PageProtector.

PageProtector can do everything that ProtectedMode can, so if you have a need for the features of PageProtector on a site, then there is no need to use ProtectedMode during development.

  • Like 2

Share this post


Link to post
Share on other sites

Just been having a look at this as it seems to be something I'm after along the lines of this thread. One question though – currently if the page is protected all you see is the message/login boxes, no header, navigation, etc. Is it possible for the message/login boxes, etc to appear within the body section of an existing template? As in, it goes to a normal page but all the content is hidden and all that's there is the login boxes?

Share this post


Link to post
Share on other sites

Just been having a look at this as it seems to be something I'm after along the lines of this thread. One question though – currently if the page is protected all you see is the message/login boxes, no header, navigation, etc. Is it possible for the message/login boxes, etc to appear within the body section of an existing template? As in, it goes to a normal page but all the content is hidden and all that's there is the login boxes?

This module has intentionally been kept very simple, hence the login box appears on it's own. I actually prefer this for sites in development so that users can't see anything about the site until the protection has been disabled.

However, what you are looking for is available in the Page Protector module. Just use the Login Template option in the module config settings. If you have any questions about it, please continue this discussion over in that thread.

  • Like 2

Share this post


Link to post
Share on other sites

Hi,

I have a site online using the protected mode module which was working very well.

Only now that I have added a second page the proteced mode is having problems.

When I login in protected mode the home page shows up like usual.

I can navigate to the second page but when I then want to return to the home page,

I have to relogin. I login again and then the same situation happens again.

Is this normal behaviour ? I checked if I have overlooked any special settings in the

configuration of the module but haven't seen anything.

Edit:

On a local server everything works fine. Haven't figured out yet how this problem is related with the online host.

Edited by pwired
PWired, merged your thread here. This is the module's support forum :-)

Share this post


Link to post
Share on other sites

Hi,

I have a site online using the protected mode module which was working very well.

Only now that I have added a second page the proteced mode is having problems.

When I login in protected mode the home page shows up like usual.

I can navigate to the second page but when I then want to return to the home page,

I have to relogin. I login again and then the same situation happens again.

Is this normal behaviour ? I checked if I have overlooked any special settings in the

configuration of the module but haven't seen anything.

Edit:

On a local server everything works fine. Haven't figured out yet how this problem is related with the online host.

I haven't come across this - I wonder if it's the fingerprint config setting - try setting that to false and see how it goes.

Share this post


Link to post
Share on other sites

Ok found it :)

I forgot to retain the User Authentication Salt when I moved the site

from local server to online server.

All good now.

  • Like 1

Share this post


Link to post
Share on other sites

Hi

I am using the ProtectedMode module version 0.0.9 but when a client logs in he can only see the homepage. The site has a top navigation bar for many pages but to see other pages the client has to each time relogin through the ProtectedMode login window. I added him to the list of users with a guest role. The same happens when I login as a superuser. I didn't see any settings in the ProtectedMode module to let a client only see the home page or all pages, also I don't see the two parts:

a) Protected Pages and b) Protect Entire Site like here in these settings:

https://processwire.com/talk/topic/7723-protecteddevelopment-mode/#entry78233

Disabling session challenge and fingerprinting does not make a difference.

Any idea ?

Share this post


Link to post
Share on other sites

Ok I understand I have to use the ProtectedPage module in order to see those configurations. I still wonder though why with the ProtectedMode module only the homepage is viewable. Maybe something on the host.

Share this post


Link to post
Share on other sites

Ok I understand I have to use the ProtectedPage module in order to see those configurations. I still wonder though why with the ProtectedMode module only the homepage is viewable. Maybe something on the host.

Are you sure you only have Protected Mode installed? I wouldn't be surprised if there were some issues if you have both modules installed.

Share this post


Link to post
Share on other sites

Hello Adrian,

I hope you are doing well!

Does "Protected Mode", or "Page Protector", have the ability to put an entire website in "maintenance mode" for an undetermined time (eventually with a customizable message), but without affecting SEO?
With a 503 status code and perhaps in combination with a particular HTTP header (Retry-After).

A nonprofit association committee has just asked me to put its website in maintenance mode (like have done other committees) because their federation has a legal problem, surely with a committee that leaved it some time ago.

Have a nice day!

Share this post


Link to post
Share on other sites

@Christophe, once I have hacked a module (in an early version) of adrian to add exactly what you are looking for.

GET  http://fua.pw.nogajski.de/ [HTTP/1.1 503 Service Temporarily Unavailable 187ms]

Date: Thu, 13 Oct 2016 20:14:54 GMT
Retry-After: Sat, 22 Oct 2016 11:22:00 GMT

protected-mode-with-SEO-503-header.jpg

So, if you like, I can upload it here as is, in a zip. Maybe, @adrian gets inspired and can add this into the current dev of his module as a maintenance feature, additonally to the site protect feature!?

very old, hacked version of protect with maintenance.zip

 

Edited by horst
added zip
  • Like 5

Share this post


Link to post
Share on other sites

Hey @horst - I am happy to add that functionality to this module, but I guess I thought it belong more in Pete's module, but if you guys would rather see it here, that's fine with me.

Do you feel like sending me a PR? Otherwise if you post the zip, I can grab the relevant bits and incorporate.

  • Like 3

Share this post


Link to post
Share on other sites

updated my post above with the zip. It is an early version that I set to 777, to avoid overwriting with updates of the original module. I also must have one version somewhere in use, where the estimated end date is reflected in the user readable message at the login screen too.

 

  • Like 1

Share this post


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

I guess I thought it belong more in Pete's module, but if you guys would rather see it here, that's fine with me.

I think, sending a 503 and "retry after" should be done everytime if the whole site is closed / protected, regardless if you call it protect mode or maintenance mode. This is important for SEO.

I think both of the modules, yours and Petes, should do that by default, when the whole site is not accessible for SearchEngines. (just my 2cents) :)

  • Like 2

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 teppo
      Needed a really simple solution to embed audio files within page content and couldn't find a module for that, so here we go. Textformatter Audio Embed works a bit like Textformatter Video Embed, converting this:
      <p>https://www.domain.tld/path/to/file.mp3</p> Into this:
      <audio controls class="TextformatterAudioEmbed"> <source src="https://www.domain.tld/path/to/file.mp3" type="audio/mpeg"> </audio> The audio element has pretty good browser support, so quite often this should be enough to get things rolling 🙂
      GitHub repository: https://github.com/teppokoivula/TextformatterAudioEmbed Modules directory: https://modules.processwire.com/modules/textformatter-audio-embed/
    • By Richard Jedlička
      Tense    
      Tense (Test ENvironment Setup & Execution) is a command-line tool to easily run tests agains multiple versions of ProcessWire CMF.
      Are you building a module, or a template and you need to make sure it works in all supported ProcessWire versions? Then Tense is exactly what you need. Write the tests in any testing framework, tell Tense which ProcessWire versions you are interested in and it will do the rest for you.

      See example or see usage in a real project.
      How to use?
      1. Install it: 
      composer global require uiii/tense 2. Create tense.yml config:
      tense init 3. Run it:
      tense run  
      For detailed instructions see Github page: https://github.com/uiii/tense
       
      This is made possible thanks to the great wireshell tool by @justb3a, @marcus and others.
       
      What do you think about it? Do you find it useful? Do you have some idea? Did you find some bug? Tell me you opinion. Write it here or in the issue tracker.
    • By Chris Bennett
      Hi all, I am going round and round in circles and would greatly appreciate if anyone can point me in the right direction.
      I am sure I am doing something dumb, or missing something I should know, but don't. Story of my life 😉

      Playing round with a module and my basic problem is I want to upload an image and also use InputfieldMarkup and other Inputfields.
      Going back and forth between trying an api generated page defining Fieldgroup, Template, Fields, Page and the InputfieldWrapper method.

      InputfieldWrapper method works great for all the markup stuff, but I just can't wrap my head around what I need to do to save the image to the database.
      Can generate a Field for it (thanks to the api investigations) but not sure what I need to do to link the Inputfield to that. Tried a lot of stuff from various threads, of varying dates without luck.
      Undoubtedly not helped by me not knowing enough.

      Defining Fieldgroup etc through the api seems nice and clean and works great for the images but I can't wrap my head around how/if I can add/append/hook the InputfieldWrapper/InputfieldMarkup stuff I'd like to include on that template as well. Not even sure if it should be where it is on ___install with the Fieldtype stuff or later on . Not getting Tracy errors, just nothing seems to happen.
      If anyone has any ideas or can point me in the right direction, that would be great because at the moment I am stumbling round in the dark.
       
      public function ___install() { parent::___install(); $page = $this->pages->get('name='.self::PAGE_NAME); if (!$page->id) { // Create fieldgroup, template, fields and page // Create new fieldgroup $fmFieldgroup = new Fieldgroup(); $fmFieldgroup->name = MODULE_NAME.'-fieldgroup'; $fmFieldgroup->add($this->fields->get('title')); // needed title field $fmFieldgroup->save(); // Create new template using the fieldgroup $fmTemplate = new Template(); $fmTemplate->name = MODULE_NAME; $fmTemplate->fieldgroup = $fmFieldgroup; $fmTemplate->noSettings = 1; $fmTemplate->noChildren = 1; $fmTemplate->allowNewPages = 0; $fmTemplate->tabContent = MODULE_NAME; $fmTemplate->noChangeTemplate = 1; $fmTemplate->setIcon(ICON); $fmTemplate->save(); // Favicon source $fmField = new Field(); $fmField->type = $this->modules->get("FieldtypeImage"); $fmField->name = 'fmFavicon'; $fmField->label = 'Favicon'; $fmField->focusMode = 'off'; $fmField->gridMode = 'grid'; $fmField->extensions = 'svg png'; $fmField->columnWidth = 50; $fmField->collapsed = Inputfield::collapsedNever; $fmField->setIcon(ICON); $fmField->addTag(MODULE_NAME); $fmField->save(); $fmFieldgroup->add($fmField); // Favicon Silhouette source $fmField = new Field(); $fmField->type = $this->modules->get("FieldtypeImage"); $fmField->name = 'fmFaviconSilhouette'; $fmField->label = 'SVG Silhouette'; $fmField->notes = 'When creating a silhouette/mask svg version for Safari Pinned Tabs and Windows Tiles, we recommend setting your viewbox for 0 0 16 16, as this is what Apple requires. In many cases, the easiest way to do this in something like illustrator is a sacrificial rectangle with no fill, and no stroke at 16 x 16. This forces the desired viewbox and can then be discarded easily using something as simple as notepad. Easy is good, especially when you get the result you want without a lot of hassle.'; $fmField->focusMode = 'off'; $fmField->extensions = 'svg'; $fmField->columnWidth = 50; $fmField->collapsed = Inputfield::collapsedNever; $fmField->setIcon(ICON); $fmField->addTag(MODULE_NAME); $fmField->save(); $fmFieldgroup->add($fmField); // Create: Open Settings Tab $tabOpener = new Field(); $tabOpener->type = new FieldtypeFieldsetTabOpen(); $tabOpener->name = 'fmTab1'; $tabOpener->label = "Favicon Settings"; $tabOpener->collapsed = Inputfield::collapsedNever; $tabOpener->addTag(MODULE_NAME); $tabOpener->save(); // Create: Close Settings Tab $tabCloser = new Field(); $tabCloser->type = new FieldtypeFieldsetClose; $tabCloser->name = 'fmTab1' . FieldtypeFieldsetTabOpen::fieldsetCloseIdentifier; $tabCloser->label = "Close open tab"; $tabCloser->addTag(MODULE_NAME); $tabCloser->save(); // Create: Opens wrapper for Favicon Folder Name $filesOpener = new Field(); $filesOpener->type = new FieldtypeFieldsetOpen(); $filesOpener->name = 'fmOpenFolderName'; $filesOpener->label = 'Wrap Folder Name'; $filesOpener->class = 'inline'; $filesOpener->collapsed = Inputfield::collapsedNever; $filesOpener->addTag(MODULE_NAME); $filesOpener->save(); // Create: Close wrapper for Favicon Folder Name $filesCloser = new Field(); $filesCloser->type = new FieldtypeFieldsetClose(); $filesCloser->name = 'fmOpenFolderName' . FieldtypeFieldsetOpen::fieldsetCloseIdentifier; $filesCloser->label = "Close open fieldset"; $filesCloser->addTag(MODULE_NAME); $filesCloser->save(); // Create Favicon Folder Name $fmField = new Field(); $fmField->type = $this->modules->get("FieldtypeText"); $fmField->name = 'folderName'; $fmField->label = 'Favicon Folder:'; $fmField->description = $this->config->urls->files; $fmField->placeholder = 'Destination Folder for your generated favicons, webmanifest and browserconfig'; $fmField->columnWidth = 100; $fmField->collapsed = Inputfield::collapsedNever; $fmField->setIcon('folder'); $fmField->addTag(MODULE_NAME); $fmField->save(); $fmFieldgroup->add($tabOpener); $fmFieldgroup->add($filesOpener); $fmFieldgroup->add($fmField); $fmFieldgroup->add($filesCloser); $fmFieldgroup->add($tabCloser); $fmFieldgroup->save(); /////////////////////////////////////////////////////////////// // Experimental Markup Tests $wrapperFaviconMagic = new InputfieldWrapper(); $wrapperFaviconMagic->attr('id','faviconMagicWrapper'); $wrapperFaviconMagic->attr('title',$this->_('Favicon Magic')); // field show info what $field = $this->modules->get('InputfieldMarkup'); $field->name = 'use'; $field->label = __('How do I use it?'); $field->collapsed = Inputfield::collapsedNever; $field->icon('info'); $field->attr('value', 'Does this even begin to vaguely work?'); $field->columnWidth = 50; $wrapperFaviconMagic->add($field); $fmTemplate->fields->add($wrapperFaviconMagic); $fmTemplate->fields->save(); ///////////////////////////////////////////////////////////// // Create page $page = $this->wire( new Page() ); $page->template = MODULE_NAME; $page->parent = $this->wire('pages')->get('/'); $page->addStatus(Page::statusHidden); $page->title = 'Favicons'; $page->name = self::PAGE_NAME; $page->process = $this; $page->save(); } }  
    • By Sebi
      Since it's featured in ProcessWire Weekly #310, now is the time to make it official:
      Here is Twack!
      I really like the following introduction from ProcessWire Weekly, so I hope it is ok if I use it here, too. Look at the project's README for more details!
      Twack is a new — or rather newish — third party module for ProcessWire that provides support for reusable components in an Angular-inspired way. Twack is implemented as an installable module, and a collection of helper and base classes. Key concepts introduced by this module are:
      Components, which have separate views and controllers. Views are simple PHP files that handle the output for the component, whereas controllers extend the TwackComponent base class and provide additional data handling capabilities. Services, which are singletons that provide a shared service where components can request data. The README for Twack uses a NewsService, which returns data related to news items, as an example of a service. Twack components are designed for reusability and encapsulating a set of features for easy maintainability, can handle hierarchical or recursive use (child components), and are simple to integrate with an existing site — even when said site wasn't originally developed with Twack.
      A very basic Twack component view could look something like this:
      <?php namespace ProcessWire; ?> <h1>Hello World!</h1> And here's how you could render it via the API:
      <?php namespace Processwire; $twack = $modules->get('Twack'); $hello = $twack->getNewComponent('HelloWorld'); ?> <html> <head> <title>Hello World</title> </head> <body> <?= $hello->render() ?> </body> </html> Now, just to add a bit more context, here's a simple component controller:
      <?php namespace ProcessWire; class HelloWorld extends TwackComponent { public function __construct($args) { parent::__construct($args); $this->title = 'Hello World!'; if(isset($args['title'])) { $this->title = $args['title']; } } } As you can see, there's not a whole lot new stuff to learn here if you'd like to give Twack a try in one of your projects. The Twack README provides a really informative and easy to follow introduction to all the key concepts (as well as some additional examples) so be sure to check that out before getting started. 
      Twack is in development for several years and I use it for every new project I build. Also integrated is an easy to handle workflow to make outputs as JSON, so it can be used to build responses for a REST-api as well. I will work that out in one section in the readme as well. 
      If you want to see the module in an actual project, I have published the code of www.musical-fabrik.de in a repository. It runs completely with Twack and has an app-endpoint with ajax-output as well.
      I really look forward to hear, what you think of Twack🥳!
      Features Installation Usage Quickstart: Creating a component Naming conventions & component variants Component Parameters directory page parameters viewname Asset handling Services Named components Global components Ajax-Output Configuration Versioning License Changelog
    • By Robin S
      Page Reference Default Value
      Most ProcessWire core inputfield types that can be used with a Page Reference field support a "Default value" setting. This module extends support for default values to the following core inputfield types:
      Page List Select Page List Select Multiple Page Autocomplete (single and multiple) Seeing as these inputfield types only support the selection of pages a Page List Select / Page List Select Multiple is used for defining the default value instead of the Text / Textarea field used by the core for other inputfield types. This makes defining a default value a bit more user-friendly.
      Note that as per the core "Default value" setting, the Page Reference field must be set to "required" in order for the default value to be used.
      Screenshot

       
      https://github.com/Toutouwai/PageReferenceDefaultValue
      https://modules.processwire.com/modules/page-reference-default-value/
×
×
  • Create New...