Restrict Access mod

Revision as of 04:16, 16 April 2017 by Hiraeth (talk | contribs) (Removed download restriction)
Restrict Access Mod
Summary Blocks access to files (except PDFs) unless user is logged in
Validation The mod is XHTML compliant.Valid-xhtml10.png
Mod Updated {{{mod_last_update}}}
Download link restrict_access_V9.0.0.5.zip
TNG 9.0
TNG 10.0
TNG 11.0
Download stats See download statistics
Author(s) Graham Chamberlain
Config file by Graham Chamberlain
Homepage Restrict Access mod (This page)
Mod Support My Mod Support
Contact Developer Contact Developer
Latest Mod V9.0.0.3 for TNG V10+
Min TNG V 9.0.0 using integrated Mod Manager
Max TNG V 11+
Files modified
showlog.php, ajx_logxml.php, anniversaries.php, showsource.php, browsenotes.php, browsemedia.php, browsealbums.php, showmedia.php, languages/English/cust_text.php, languages/English-UTF8/cust_text.php
Related Mods
Notes


Purpose of Mod

This mod is intended for those with open access to their TNG site but who wish to disable access to media and other selected files for non-registered users. It allows access to the selected files only for logged-in users. If a non-logged-in user tries to access the relevant file they will see a template-formatted page that informs them they are not authorised to view that file and a links to the Home page and Previous page.

NOTE:

  • The mod does not currently inhibit access to PDF media
  • This mod is not required if your site is 'closed' and requires log-in


Mod Developer

The Mod Developer is Graham Chamberlain.

Mod Manager config files provided by Graham Chamberlain.


Automated Installation

  1. Download the appropriate file for your TNG version from the download links in the mod summary area in the upper right.
  2. Extract the downloaded zip file to your 'mods folder.
  3. Follow the normal automated installation for Mod Manager, as shown in the example Mod Manager - Installing Config Files to install the appropriate source_title_display.cfg file.

Manual Customisation

If you wish to allow browsing of media but still disallow viewing the individual media items, you should remove the directive for browsemedia.php. Alternatively, you could limit the media restriction to browsing specific collections. The following example would only block the browsing of 'histories' for non-logged-in users:

 if(( ! $currentuser )&&($mediatypeID=="histories")) { 
     $showguest=1; 
     include("extensions/noaccess.php"); 
     exit; 
     } 

and to limit the restriction to 'histories' and 'photos':

 if(( ! $currentuser )&&($mediatypeID=="histories" || $mediatypeID=="photos")) { 
     $showguest=1; 
     include("extensions/noaccess.php"); 
     exit; 
     }

NOTE: It is not possible to use the above method to limit the viewing of individual images (showmedia.php) to a specific collection


Further Application / Customisation

The principles used in the directives of this mod to limit access also can be applied to other files.

Additional links can be provided for the Restriction Warning page by appropriately editing mods/restrict_access/noaccess.php and then reinstalling the mod.

The cfg file can be edited to suit the user's requirements:

  1. add or remove directives for affected files: Access Log, All Media, Anniversaries & Dates, Calendar, Notes and Sources
  2. change the text variables
    $text['authorise'] = "You are not authorised to view this page";
    and/or
    $text['regfam'] = "To view this resource you must be a family member and register for a user-account";
    to suit your preferred description
  3. add appropriate language directives for your site (do not change the default English language directives other than to give a different text definition as described in the previous point.

Visualisation

This is how the standard Restriction Warning appears in template8:  

Revision History

Version Date Contents
v9.0.0.5 25 May 2016 correct wikipage link and adds text (UTF-8) variable for Danish
v9.0.0.4 4 February 2016 adds text variable 'regfam' missing from v9.0.0.3 and text (UTF-8) variables for Dutch, French, German and Spanish
v9.0.0.3 22 April 2012 adds text variable 'goback' missing from v9.0.0.2
v9.0.0.2 5 April 2012

TNG User sites using this mod

If you download and install this mod, please add your TNG site to the table below

URL User Note Mod-Version/TNG-Version User-language
Chamberlain & Eidenbenz Genealogy Graham Chamberlain ... 9.0.0.4/10.1.3 English, French, German, Spanish, Dutch
Kemp(e) Family History Andrew Kemp see User:Kempons EN
The Dutton's of Vermont Darrin Dutton 9.0.0.3/10.1.0 EN
Kleinmann Genealogy John Kleinmann 9.0.0.5 / 11.0.2 EN
Turner Mob Genealogy Margaret Grogan Turner 9.0.0.3/10.1.1 EN
Grogan Mob Genealogy Margaret Grogan Turner 9.0.0.3/10.1.1 EN
Roots & Relatives Remembered Ron Krzmarzick Partially Public 9.0.0.5/11.1 EN
The Extended Craxford Family Magazine Alan Craxford 9.0.0.5/10.1.3 EN
Crawford County Genealogy Gateway Frank Bernosky 9.0.0.3/11.1 EN