HRDIODB
[ class tree: HRDIODB ] [ index: HRDIODB ] [ all elements ]
Packages:
HRDIODB

Source for file conf.dist.php

Documentation is available at conf.dist.php

  1. <?php
  2. /**
  3.  * HRDI Observational Database configuration file.
  4.  * This file contains the configuration options used for the HRDI Observational
  5.  * Database. All configurable elements can be changed by editing this file. The
  6.  * look and feel of the UI should be changed by editing the CSS file. This file
  7.  * should be copied to 'conf.php' and then edited for the given setup. The code
  8.  * reads 'conf.php', while the documentation parser reads 'conf.dist.php'.
  9.  * @package HRDIODB
  10.  */
  11.  
  12. /**
  13.  * This file is part of HRDIODB.
  14.  *
  15.  * HRDIODB is free software; you can redistribute it and/or modify
  16.  * it under the terms of the GNU General Public License as published by
  17.  * the Free Software Foundation; either version 2 of the License, or
  18.  * (at your option) any later version.
  19.  *
  20.  * HRDIODB is distributed in the hope that it will be useful,
  21.  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  22.  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  23.  * GNU General Public License for more details.
  24.  *
  25.  * You should have received a copy of the GNU General Public License
  26.  * along with HRDIODB; if not, write to the Free Software
  27.  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  28.  */
  29.  
  30. /**
  31.  * Error reporting level.
  32.  */
  33. error_reporting(E_ALL ^ E_NOTICE);
  34.  
  35. /**
  36.  * Database configuration options.
  37.  */
  38. $username="joe";
  39. $password="somepass";
  40. $database="mydb";
  41. $server = "localhost";
  42.  
  43. /**
  44.  * Data source name.
  45.  * The data source name is used by PEAR to connect to the database.
  46.  * @global string $dsn 
  47.  */
  48. $dsn="mysql://$username:$password@$server/$database";
  49.  
  50. /**
  51.  * UARS Day 1 time stamp.
  52.  * The Unix time stamp of UARS Day 1 (September 12th, 1991)
  53.  * @global string $day1_ts 
  54.  */
  55. $day1_ts = "684648000";
  56.  
  57. /**
  58.  * HRDI admin e-mail.
  59.  * The e-mail address of the HRDI admin who should be contacted in case of
  60.  * problems.
  61.  * @global string $hrdi_admin 
  62.  */
  63. $hrdi_admin = "user@domain.edu";
  64.  
  65. /**
  66.  * Random password length.
  67.  * The desired length of the randomly generated password which is sent to users
  68.  * who reset their password.
  69.  * @global integer $pass_length 
  70.  */
  71. $pass_length = 10;
  72.  
  73. /**
  74.  * 'From' mail address.
  75.  * This e-mail address user in The 'From' address of the password reset e-mail.
  76.  * @global string $mail_from 
  77.  */
  78. $mail_from = $hrdi_admin;
  79.  
  80. /**
  81.  * E-mail subject.
  82.  * The string used in the 'Subject' of the password reset e-mail.
  83.  * @global string $mail_subject 
  84.  */
  85. $mail_subject = "Some subject";
  86.  
  87. /**
  88.  * E-mail message.
  89.  * This is the plain text used in the 'Body' of the e-mail message. The
  90.  * (case sensitive) text RANDOM_PASS will be replaced with the actual
  91.  * randomly generated password.
  92.  * @global string $mail_message 
  93.  */
  94. $mail_message = "This is your new password: RANDOM_PASS";
  95.  
  96. /**
  97.  * Archive size.
  98.  * The desired maximum size of downloadable archives in megabytes. This size
  99.  * should be at minimum as large as the sum of all the average sizes of the
  100.  * files that can be attached to a single day.
  101.  * @global integer $max_archive_size 
  102.  */
  103. $max_archive_size = 10;
  104.  
  105. /**
  106.  * Archive prefix.
  107.  * The prefix where compressed archives will be kept, available for download.
  108.  * This location will be periodically cleaned, but it should be capable of
  109.  * storing large amounts of data. It should also be writeable by the Apache
  110.  * user and/or group.
  111.  * @global string $archive_prefix 
  112.  */
  113. $archive_prefix = "/var/www/downloads";
  114.  
  115. /**
  116.  * Temporary archive prefix.
  117.  * The prefix where the archives are kept while being created. Once they are
  118.  * done being created, the files will be moved to $archive_prefix. This
  119.  * location should be capable of storing large amounts of data. It should also
  120.  * be writeable by the Apache user and/or group.
  121.  * @global string $temp_prefix 
  122.  */
  123. $temp_prefix = "/tmp";
  124.  
  125. /**
  126.  * Archive download prefix.
  127.  * The prefix where the compressed archives will be visible to the users. This
  128.  * should be a symbolic link or an Apache alias pointing to the archive prefix
  129.  * specified in $archive_prefix.
  130.  * @global string $download_prefix 
  131.  */
  132. $download_prefix = "/downloads";
  133.  
  134. /**
  135.  * User e-mail domain checking.
  136.  * When a user enters an e-mail to register, the domain of the e-mail can be
  137.  * checked by doing a DNS lookup. This is a nice way to ensure that the e-mail
  138.  * address at least has a chance of being real. It should not cause any
  139.  * problems as long as the DNS servers are working.
  140.  * @global bool $check_dns 
  141.  */
  142. $check_dns = TRUE;
  143.  
  144. /**
  145.  * Offline file prefix.
  146.  * The prefix where offline day and week pages will be created. This directory
  147.  * only needs to be writeable by the user and/or group running the offline page
  148.  * generation script.
  149.  * @global string $offline_prefix 
  150.  */
  151. $offline_prefix = "offline";
  152.  
  153. /**
  154.  * Minimum number of mode rows.
  155.  * This variable specifies the minimum number of rows that should be displayed
  156.  * in the modes table. If the number of modes for the day is less than this
  157.  * number, additional empty rows will be displayed.
  158.  */
  159. $min_mode_rows = 4;
  160.  
  161. /**
  162.  * Minimum number of file rows.
  163.  * This variable specifies the minimum number of rows that should be displayed
  164.  * in the files table. If the number of files for the day is less than this
  165.  * number, additional empty rows will be displayed.
  166.  */
  167. $min_file_rows = 10;
  168.  
  169. /**
  170.  * Minimum number of link rows.
  171.  * This variable specifies the minimum number of rows that should be displayed
  172.  * in the links table. If the number of links for the day is less than this
  173.  * number, additional empty rows will be displayed.
  174.  */
  175. $min_link_rows = 2;
  176.  
  177. /**
  178.  * Table keys.
  179.  * This array associates primary keys with HRDI tables. When an entry is being
  180.  * processed by the CSV parser, it is looked up by the table key. If the key
  181.  * exits, an update is performed. If the key does not exist, an insert is
  182.  * performed.
  183.  * @global array $table_keys 
  184.  */
  185. $table_keys = array("HRDI_Days"  => "UARS_Day", 
  186.                     "HRDI_Downloads" => "ID",
  187.                     "HRDI_FileTypes" => "ID",
  188.                     "HRDI_Files" => "Filename",
  189.                     "HRDI_History" => "ID",
  190.                     "HRDI_Links" => "ID",
  191.                     "HRDI_Modes" => "ID",
  192.                     "HRDI_Pids"  => "Pid",
  193.                     "HRDI_Users" => "ID");
  194.  
  195. /**
  196.  * CSV single line character limit.
  197.  * This integer specifies the largest possible character length to be expected
  198.  * in a single line of a CSV file.
  199.  * @global integer $csv_line_character_limit 
  200.  */
  201. $csv_line_character_limit = 10000;
  202.  
  203. ?>
Documentation generated on Tue, 23 Jan 2007 22:57:43 -0500 by phpDocumentor 1.3.0RC6