TNG_Wiki

Public Access Control

Revision as of 14:58, 9 June 2015 by XerxX (talk | contribs)
Access panel
Summary Introduces a panel in General Settings to restrict public access to selected parts of your TNG system.
Validation The mod is XHTML compliant.Valid-xhtml10.png
Mod Updated {{{mod_last_update}}}
Download link for
TNG 10.1.1
Access_panel_mod_v10.1.1.Beta11.zip
Download stats Access panel v10.1.1.Beta11
Author(s) Erik Hoppe
Homepage Access panel (this page)
Mod Support My Mod Support
Contact Developer My Mod Support
Latest Mod 10.1.1.Beta11
Min TNG V 10.1.1
Max TNG V 10.1.1
Files modified
See TNG Modules Impacted
Related Mods
Restrict_Access_mod,
Media_Privacy_Mod,
Restrict_Image_Preview
all by Graham Chamberlain
Notes
Author of TNG Colouring Book
Mods by me: At my user page.


LATEST VERSION

The latest beta version is Beta #11


Preface

This is a compilation of my mods AccessRestriction and AccessRestriction_More, made for TNG v10.1.1.

This mod makes both the mods obsolete for use with TNG v10.1.1
They must be uninstalled and removed from your mods folder before installing this mod.

As this mod doesn't make any database calls it may be possible to use it in earlier TNG versions.
Please report if you try it.


Purpose of the mod

Introduces a panel in Set Up >> General Settings: The Public Access panel where you can select which parts of your TNG system that you want to hide from the Public Guests or require a login, while keeping permissions and restrictions for your logged in users intact.


Why "Beta"?

The main purpose of posting this version of the mod is that I hope to have reports of failure and successes when it is used with other mods.

This mod makes lots of changes throughout your TNG system and there will, inevitably I think, be conflicts with other mods.
If I'm alerted of those mods I will try to modify the code to suit them too (and/or talk to the mod maker).

I would also like to know if you have success or failure installing the mod in a TNG v10.0.x environment.


Developer

This mod was developed by Erik Hoppe


Credits

My sincere Thank You to Henny Savenije for his wonderful patience and thorough testing of this mod.
Martin Pannier is also helping a lot, pointing me to important details.


Reported Successes / Failures with other mods

Please add to this list and/or report by this Mod Support link, thank you.

Mod By Version Installed Before
Access p. mod 		Installed After
Access p. mod 		Note
Ancestor_map Réal Charlebois et al v10.1.0.1 Success E Hoppe* Success E Hoppe*
Ancestor_map Add 4 placelevels Réal Charlebois et al v10.1.0.0 Success E Hoppe* Success E Hoppe*
Census_Plus_International Janice Nation et al v10.1.0.3d Success E Hoppe* Success E Hoppe* Only Installed mod
Count_Descendants Robin Richmond v10.1.0.6 Success E Hoppe* Success E Hoppe*
Family_Chart_Mod Chris Moss v10.1.0.3a Success E Hoppe* Success E Hoppe*
Family_Preview_Mod Jeff Robison v10.1.0.2c Success E Hoppe* Success E Hoppe*
Google_Maps_-_More_Place_Levels_Mod Add 4 placelevels Roger Moffat v10.1.0.1 Success E Hoppe* Success E Hoppe*
Life_Dates_Mod Roger Mitchell v10.0.3.0 Success E Hoppe* Success E Hoppe*
Mobile_Media Ken Roy v10.1.0.2a Failure E Hoppe* Success E Hoppe*
Mobile_Site_Enhancements Ken Roy v10.1.0.2a Failure E Hoppe* Success E Hoppe*
Mobile_Site_No_Previews Ken Roy v10.1.0.2a Success E Hoppe* Success E Hoppe*
Person_Map mobile_ind_page_person_map Bart 'Roebie' Degryse v10.1.0.2a Success E Hoppe* Success E Hoppe*
Relationship_Display_Mod Jeff Robison v10.0.0.1 Success E Hoppe* Success E Hoppe*
Responsive_Tables Ken Roy v10.1.0.2a Success E Hoppe* Success E Hoppe*
Responsive_Tables Browsesource Ken Roy v10.1.0.2a Success E Hoppe* Success E Hoppe*
Responsive_Tables No Slideshow Ken Roy v10.1.0.1 Success E Hoppe* Success E Hoppe*
TextPlus_Charts Robin Richmond v10.1.0.10a Success E Hoppe* Success E Hoppe*
My own mods (f v10.1.1) listed at my User page Erik Hoppe Misc. Success E Hoppe* Success E Hoppe*
  • ) All mods I report are installed together.


Mod Makers: Innermenu for Your mods

If you add a selection to the innermenu of any of the scripts descend.php, familygroup.php, getperson.php or pedigree.php and it opens a custom page, you can use the code-snippets below in your script to make your innermenu look the same as in the calling script, wether this mod is installed or not.

If an item is hidden from public view in the innermenu of, f.ex, descend.php it will be displayed at your innermenu and the user will arrive at the 'Log in page if it is clicked.
Using the code below will prevent the item to be displayed if the Access panel is/will be installed and/or the item is/will be hidden.
If the Access panel is not installed, there is no difference.

Only the relevant part of the innermenu is shown and only lines containing $xerxxProtect[] are added to the original script.
All four innermenus in a zipped .txt file


What is Not protected

  • Media displayed by other mods may not be protected, depending on how the mod displays the media.
  • Media displayed at index.php (f.ex. a Random or Featured Photo) may not be protected
  • Most Wanted will show media and suggest.php will open if the link on Most Wanted page is clicked.

The TNG "event" named Associations is not protected by this mod.
I have yet to find out what it really is and where, when and why it is displayed.
Quite frankly: I have read some of the Help but I have never used it, not even tried it, yet.

Do you think this is a vital part that should be included in the panel?


Requirements

TNG version: 10.1.1
  • A working TNG installation.
  • A backup of all affected files (see the list below)
  • An installed current version of the Mod Manager (is already included in TNG v10.1.1)


Before installation

  • If you have installed AccessRestriction and/or AccessRestriction More mods, you must first
  1. Uninstall the one(s) you have
  2. Remove the .cfg file(s) and the folder AccessRestriction10 from your mods folder
  • Check the table above to see if you have to uninstall any of your mods while installing this one.
    For example, the following mods must both be uninstalled so the Access panel mod can be installed. They can be re-installed after installing the Access panel mod.


Installation

  1. Click on the download link, shown in the summary in the upper right corner of the page.
  2. Un-zip the downloaded file and you will find a folder: Open it.
  3. Move/copy/FTP the .cfg file and the folder named AccessPanel_101 to the mods folder of your TNG system.
  4. Follow the normal automated installation for Mod Manager, as shown in the example Mod Manager - Installing Config Files to install the mod.
  5. Re-install any mods that you had to uninstall in order to be able to install the Access panel mod

In the event of a problem


After Installation

Go to Admin >> Setup >> General Settings to find the Public Access panel.
Set the public view to your liking and click the Save button.


Complete Description of Settings

A complete description of all settings, including how they interact with your settings in Trees (Gedcom and PDF permissions) and Site Design and Definition (displaying the Share, Print and Bookmark icons), is found here: Access panel settings


Custom Text Additions

Note: A few texts are still hard-coded in English. Will be variables.

Note: The config file includes only the English language custom text.
There are German and Swedish translations if they are present in your TNG system.
For other languages you can modify the config file to add the custom text or manually add to whatever language you like.
(A small preparation for, f.ex, the German language is done: See the last entries)

English custom text For Reference Only!


$text['textHide'] = "Hide";
$text['textMedia'] = "Media";
$text['textNotes'] = "Notes";
$text['textRepositories'] = "Repositories";
$text['textSources'] = "Sources";
$text['textReports'] = "Reports";
$text['textRelationship'] = "Relationship";
$text['textExtractgedcom'] = "GEDCOM";
$text['textSuggest'] = "Suggest";
$text['textAncestors'] = "Ancestors";
$text['textDescendants'] = "Descendants";
$text['textTimeline'] = "Timeline";
$text['textShare'] = "Share";
$text['textPrint'] = "Print";
$text['textBookmark'] = "Bookmark";
$text['textLogin'] = "Log in";

$text['xerxxProtectPanel'] = "Public Access";
$text['xerxxProtectShow'] = "Show";
$text['xerxxProtectTab'] = "Tab ";
$text['xerxxProtectTextStart'] = "Select ";
$text['xerxxProtectTextEnd'] = " to hide from public view";
$text['xerxxProtectTextFull'] = " and require ";
$text['xerxxProtectData'] = "Data";
$text['xerxxProtectIcons'] = "Icons";
$text['xerxxProtectTabs'] = "Tabs";
$text['xerxxProtectTSelections'] = "Tab <i>Selections</i>";
$text['xerxxProtectAhnentafel'] = "Ahnentafel";
$text['xerxxProtectPDF'] = "PDF";
$text['xerxxProtectRegister'] = "Register";

$text['xerxxProtectHideSet'] = "<u>When "" . $text['textHide'] . "" is set:</u> ";
$text['xerxxProtectLogInSet'] = "<u>When "" . $text['textLogin'] . "" is set:</u> ";
$text['xerxxProtectShowSet'] = "<u>When "" . $text['xerxxProtectShow'] . "" is set:</u><br />";
$text['xerxxProtectExpl1'] = "Will show icon, text and and Log in link.";
$text['xerxxProtectExpl2'] = "PDF printing opt for Tabs <i>Individuial</i><br />and <i>Family</i> are hidden from public view.<br />";
$text['xerxxProtectExpl3'] = "Will only affect Not logged in users.<br />";
$text['xerxxProtectExpl4'] = " permissions for all are set in";
$text['xerxxProtectExpl5'] = "For Logged in users permissions are set in";
$text['xerxxProtectExpl6'] = " Admin >> Trees.<br />";
$text['xerxxProtectExpl7'] = "All";
$text['xerxxProtectExpl8'] = "<br />Admin >> Setup >> General Settings >> Site Design and Definition.<br />";

$text['xerxxLogin'] = " (Log in)";
$text['xerxxNoaccount'] = "You need a user account to ";
$text['xerxxNoaccountView'] = "view ";
$text['xerxxNoaccountListen'] = "listen to ";
$text['xerxxNoaccountRead'] = "read ";
$text['xerxxNoaccountDEView'] = "";
$text['xerxxNoaccountDEListen'] = "";
$text['xerxxNoaccountDERead'] = "";

The last three can be used for the German language, f.ex, and MUST be present in all languages.


Uninstalling the mod

  • Check the table above to see if you have to uninstall any of your mods while uninstalling this one.
    For example, the following mods must both be uninstalled so the Access panel mod can be installed. They can be re-installed after installing the Access panel mod.

If you want to completely Remove (uninstall) this mod and all its tables, you should

  1. click the Uninstall button to uninstall the mod and then
  2. click the Delete button to delete the config file from the mods folder.
  3. Go to Setup >> General Settings and click the Save button to clear the config.php file from the protection flags.


Revision History

Version Date Description
V10.1.1.Beta11 9 June 2015 Added German (thanks Martin Pannier) and Swedish texts.
whatsnew.php does not require log in any more.
headstones.php and showmap.php are now protected (shows icons and Log in link). cemeteries.php will not show the "All Headstones" link. (Martin!)
Panel name is "Public Access" to emphasize that no user rights/restrictions are set there.
V10.1.1.Beta9 2 June 2015 Did not install after Relationship Display mod, but before. Fixed. Thanks to Martin Pannier for the alert.
V10.1.1.Beta8 1 June 2015 A small change to fit better with mobile_site_enhancements mod. Other lines make it not possible to install it before Access panel.
V10.1.1.Beta7 31 May 2015 Introduction.


Visualization of this mod

Click here for screen-shots from a fully protected site and of graphic trees if they should be accessible.

The Access panel after mod installation: No restrictions are set
 
The below images show results when Media, Notes and Sources are set to Log in.
Individ's Media section (part), Logged-in view (67%) The same individ's Media section (full), Not logged-in view (67%)
   


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
Andersson, Hoppe, Sahlin, Thorell Erik Hoppe Mod author. Pre-mod! 9.1.1! Swedish, German, English


TNG Modules Impacted

NOTE: The file config.php is not modified by the mod but will be affected by the actions of the modified file admin_updateconfig.php,
and should be backed up prior to installing this mod.


The following TNG Modules are modified, and should be backed up prior to installing this mod:

  • admin_genconfig.php
  • admin_updateconfig.php
  • ahnentafel.php
  • cemeteries.php
  • descend.php
  • descendtext.php
  • extrastree.php
  • familygroup.php
  • functions.php
  • genlib.php
  • getperson.php
  • globallib.php
  • headstones.php
  • mostwanted.php
  • pedbox.php
  • pedigree.php
  • pedigreetext.php
  • personlib.php
  • placesearch.php
  • register.php
  • showmap.php
  • verticalchart.php


The following TNG Modules vill only have re-direction code added to the beginning,
and should also be backed up prior to installing this mod:

  • bookmarks.php
  • browsealbums.php
  • browsemedia.php
  • browsenotes.php
  • browserepos.php
  • browsesources.php
  • gedform.php
  • relateform.php
  • relationship.php
  • reports.php
  • showalbum.php
  • showmedia.php
  • showrepo.php
  • showreport.php
  • showsource.php
  • suggest.php
  • timeline.php


The custom texts will be added to these files, which should also be backed up prior to installing this mod:

  • languages/English/cust_text.php
  • languages/English-UTF8/cust_text.php
  • languages/German/cust_text.php - if present
  • languages/German-UTF8/cust_text.php - if present
  • languages/Swedish/cust_text.php - if present
  • languages/Swedish-UTF8/cust_text.php - if present


These images will be copied to your (root) img folder:

  • xerxxNonotes.png
  • xerxxNoalbums.png
  • xerxxNophotos.png
  • xerxxNodocuments.png
  • xerxxNoheadstones.png
  • xerxxNohistories.png
  • xerxxNorecordings.png
  • xerxxNovideos.png
  • xerxxNocitations.png
  • xerxxNomedia.png
Retrieved from "https://tng.lythgoes.net/wiki/index.php?title=Public_Access_Control&oldid=33151"