r2623 move user-modifiable files to a separate dir (closes: 39)

diff --git a/ChangeLog b/ChangeLog
index e462704cadd8b9f6247fbd84822fc60ec41fbe38..922311c0e9ae6b4934a020e66fd267271c58e211 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -14,6 +14,7 @@
        update: add network security chapter and dictionary entries.  closes ticket 148 (by Aaron)
        update: add HP and Juniper dictionary entries.  closes tickets 145 and 165 (by Aaron)
        update: combined two forms on object properties page into one.  closes tickets 36 and 87 (by Aaron)
+       update: secret.php and local.php moved from inc/ to local/. closes ticket 39 (by Aaron)
        update: resolved performance issue for systems with many L2 ports
        update: enable username handling in Cisco switch connector
        update: introduce icons for routers and SLB

diff --git a/README b/README
index 66e445e18b97a5adb479b07f953bc1091fe6ef20..c4f12ee66371d7262203d4463f888dc2a2833318 100644 (file)
--- a/README
+++ b/README
@@ -61,8 +61,8 @@ If you already have a working installation, the following procedure
 should be sufficient:
 
 0. BACKUP YOUR DATABASE
-1. Remove all existing files except inc/secret.php, gateways'
-   configuration (in the gateways directory) and local mod (inc/local.php).
+1. Remove all existing files except local/secret.php, gateways'
+   configuration (in the gateways directory) and local mod (local/local.php).
 2. Unpack the new tarball into the place.
 3. Open the RackTables page in your browser. The software detects version
    mismatch and displays a message telling to log in as admin to finish
@@ -108,6 +108,13 @@ during the upgrade.
 
 *** Upgrading to 0.17.0 ***
 
+User-modifiable files have been moved to a dedicated directory to make future upgrades easier.
+cd to the RackTables directory and run these commands:
+
+1. mkdir local
+2. mv inc/secret*.php local/
+3. mv inc/local.php local/
+
 This release is the first to take advantage of the foreign key support
 provided by the InnoDB storage engine in MySQL.  The installer and
 upgrader scripts check for InnoDB support and cannot complete without it.

diff --git a/inc/init.php b/inc/init.php
index f0f39898a802c7647e2d0e0ddd4e408bba4d317d..562ce2e0a48e5bc0d26114ba3a651d1dc5311e6f 100644 (file)
--- a/inc/init.php
+++ b/inc/init.php
@@ -23,13 +23,13 @@ require_once 'inc/config.php';
 require_once 'inc/interface.php';
 require_once 'inc/functions.php';
 require_once 'inc/database.php';
-if (file_exists ('inc/secret.php'))
-       require_once 'inc/secret.php';
+if (file_exists ('local/secret.php'))
+       require_once 'local/secret.php';
 else
 {
        showError
        (
-               "Database connection parameters are read from inc/secret.php file, " .
+               "Database connection parameters are read from local/secret.php file, " .
                "which cannot be found.\nYou probably need to complete the installation " .
                "procedure by following <a href='${root}install.php'>this link</a>.",
                __FILE__
@@ -183,8 +183,8 @@ require_once 'inc/ophandlers.php';
 require_once 'inc/triggers.php';
 require_once 'inc/gateways.php';
 require_once 'inc/snmp.php';
-if (file_exists ('inc/local.php'))
-       require_once 'inc/local.php';
+if (file_exists ('local/local.php'))
+       require_once 'local/local.php';
 
 // These will be filled in by fixContext()
 $expl_tags = array();

diff --git a/install.php b/install.php
index 4bbcf73fe08fc1d5940f837e1507478164d7b1ce..0bd6796b1ce793e73fcb429ac37d5a075be84b98 100644 (file)
--- a/install.php
+++ b/install.php
@@ -61,7 +61,7 @@ echo "<input type=hidden name=step value='${next_step}'>\n";
 // Check if the software is already installed.
 function not_already_installed()
 {
-       @include ('inc/secret.php');
+       @include ('local/secret.php');
        if (isset ($pdo_dsn))
        {
                echo 'Your configuration file exists and seems to hold necessary data already.<br>';
@@ -164,10 +164,10 @@ function platform_is_ok ()
 // credentials.
 function init_config ()
 {
-       if (!is_writable ('inc/secret.php'))
+       if (!is_writable ('local/secret.php'))
        {
-               echo "The inc/secret.php file is not writable by web-server. Make sure it is.";
-               echo "The following commands should suffice:<pre>touch inc/secret.php\nchmod 666 inc/secret.php</pre>";
+               echo "The local/secret.php file is not writable by web-server. Make sure it is.";
+               echo "The following commands should suffice:<pre>touch local/secret.php\nchmod 666 local/secret.php</pre>";
                echo 'Fedora Linux with SELinux may require this file to be owned by specific user (apache) and/or executing "setenforce 0" for the time of installation. ';
                echo 'SELinux may be turned back on with "setenforce 1" command.';
                return FALSE;
@@ -224,10 +224,10 @@ function init_config ()
                return FALSE;
        }
 
-       $conf = fopen ('inc/secret.php', 'w+');
+       $conf = fopen ('local/secret.php', 'w+');
        if ($conf === FALSE)
        {
-               echo "Error: failed to open inc/secret.php for writing";
+               echo "Error: failed to open local/secret.php for writing";
                return FALSE;
        }
        fwrite ($conf, "<?php\n/* This file has been generated automatically by RackTables installer.\n");
@@ -252,7 +252,7 @@ function init_config ()
 
 function connect_to_db ()
 {
-       require ('inc/secret.php');
+       require ('local/secret.php');
        global $dbxlink;
        try
        {

diff --git a/inc/secret-sample.php b/local/secret-sample.php
similarity index 100%
rename from inc/secret-sample.php
rename to local/secret-sample.php

diff --git a/upgrade.php b/upgrade.php
index f24a97b4aa3e475e714924acdf6a8ebd406676fc..c37eca8c770e4452770d8898178b4da380c4d634 100644 (file)
--- a/upgrade.php
+++ b/upgrade.php
@@ -2,8 +2,8 @@
 
 $relnotes = array
 (
-       '0.17.0' => "This release requires more options to secret.php. Add the " .
-               "following into inc/secret.php:<br><br>" .
+       '0.17.0' => "This release requires changes to the configuration file. " .
+               "Move inc/secret.php to local/secret.php and add the following to the file:<br><br>" .
                "\$user_auth_src = 'database';<br>\$require_valid_user = TRUE;<br><br>" .
                "(and adjust to your needs, if necessary)<br>" .
                "Another change is the addition of support for file uploads.  Files are stored<br>" .
@@ -257,12 +257,12 @@ require_once 'inc/interface.php';
 
 require_once 'inc/config.php';
 require_once 'inc/database.php';
-if (file_exists ('inc/secret.php'))
-       require_once 'inc/secret.php';
+if (file_exists ('local/secret.php'))
+       require_once 'local/secret.php';
 else
-       die ("Database connection parameters are read from inc/secret.php file, " .
-               "which cannot be found.\nCopy provided inc/secret-sample.php to " .
-               "inc/secret.php and modify to your setup.\n\nThen reload the page.");
+       die ("Database connection parameters are read from local/secret.php file, " .
+               "which cannot be found.\nCopy provided config/secret-sample.php to " .
+               "local/secret.php and modify to your setup.\n\nThen reload the page.");
 
 try
 {