====== ondeniedlogin Plugin ======

---- plugin ----
description: redirects unknown users to a login form on denied requests
author     : Samuel Fischer
email      : sf@notomorrow.de
type       : action
lastupdate : 2009-04-21
compatible : 
depends    : 
conflicts  : 
similar    : showlogin
tags       : redirect, authentication, denied, !obsolete

downloadurl: http://samfisch.de/_media/documentation/sfdom/plugins/dokuplugin-ondeniedlogin.tgz
----

**Functionality now included in DokuWiki**: Dokuwiki now includes the login form in the denied page, when useful. So this plugin is obsolete.

>__EDIT by //asheenlevrai// on 20140924__: Well I do not completely agree although the above is true for most users. On the 2014 version of dokuwiki (Ponder Stibbons) the **denied page** now includes the login __form__, while this plugin redirects to the **login page** whenever someone ends up on the denied page. People who use a customized version of the login page (for instance when using the plugin [[plugin:legalnotice|legal notice]] may still want to have the login page rather than the permission denied page displayed at all times since the new (2014) denied page will not include these customizations.
>> Fixed in [[plugin:legalnotice|legal notice]] for some time now - it also listens to "denied" action and will display it's text there, too.  --- [[user>einhirn|Christian Marg]] //2016-08-22 10:46//
===== Download and Installation =====
FIXME Downloads have error. Missing "php" in first line. Use copy and paste method or edit the file noted in copy and paste method.


Search and install the plugin using the [[plugin:extension|Extension Manager]]. 

  * http://samfisch.de/_media/documentation/sfdom/plugins/dokuplugin-ondeniedlogin.tgz

Refer to [[:Plugins]] on how to install plugins manually. Or copy paste this code into your lib/plugins/ondeniedlogin/action.php .

<code php action.php>
<?php
  if(!defined('DOKU_INC')) die();
  if(!defined('DOKU_PLUGIN')) define('DOKU_PLUGIN',DOKU_INC.'lib/plugins/');
  require_once(DOKU_PLUGIN.'action.php');

  class action_plugin_ondeniedlogin extends DokuWiki_Action_Plugin {

    function getInfo(){
      return array(
        'author' => 'Samuel Fischer',
        'email'  => 'sf@notomorrow.de',
        'date'   => '2009-04-21',
        'name'   => 'ondeniedlogin',
        'desc'   => 'redirects unknown users to a login form on denied requests',
        'url'    => 'http://www.dokuwiki.org/plugin:ondeniedlogin',
      );
    }

  function register(Doku_Event_Handler $controller) {
      $controller->register_hook('TPL_ACT_RENDER', 'BEFORE',  $this, 'ondeniedlogin');
    }
    
    function ondeniedlogin(&$event, $param) {
        global $ACT, $INFO;

        if($ACT!='denied') return;
          if(!is_array($INFO['userinfo']))
                $ACT = 'login';
    }

  }
</code>

===== Patches =====

==== Show Search Page for Authenticated Users ====

This adds the following functionality to this plugin: When your ACLs allow someone to see some pages but maybe not the start page, this helps him because he gets some search hits instead of "Permission denied"...

<code diff ondenied-search.patch>
--- ondeniedlogin/action.php    2011-08-26 16:47:00.000000000 +0200
+++ ondeniedlogin/action.php    2011-08-26 16:54:23.000000000 +0200
@@ -26,6 +26,8 @@
       if($ACT!='denied') return;
         if(!is_array($INFO['userinfo']))
        $ACT = 'login';
+        else
+       $ACT = 'search';
     }

   }

</code>

==== Use Earlier Event ====

Some templates (e.g. [[template:dokuwiki]]) set html classes on outer elements describing the action.  The TPL_ACT_RENDER event is too late to alter this.  The change below switches to use [[devel:event:ACTION_HEADERS_SEND]], so immediately after DokuWiki sends the 403 permission denied header.

<code php>
      $controller->register_hook('ACTION_HEADERS_SEND', 'AFTER',  $this, 'ondeniedlogin');
</code>